AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceName' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

CacheClusterNotFoundFault:

The requested cluster ID does not refer to an existing cluster.

CacheParameterGroupNotFoundFault:

The requested cache parameter group name does not refer to an existing cache parameter group.

CacheSecurityGroupNotFoundFault:

The requested cache security group name does not refer to an existing cache security group.

CacheSubnetGroupNotFoundFault:

The requested cache subnet group name does not refer to an existing cache subnet group.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

ReservedCacheNodeNotFoundFault:

The requested reserved cache node was not found.

SnapshotNotFoundFault:

The requested snapshot name does not refer to an existing snapshot.

UserNotFoundFault:

The user does not exist or could not be found.

UserGroupNotFoundFault:

The user group was not found or does not exist

ServerlessCacheNotFoundFault:

The serverless cache was not found or does not exist.

InvalidServerlessCacheStateFault:

The account for these credentials is not currently active.

ServerlessCacheSnapshotNotFoundFault:

This serverless cache snapshot could not be found or does not exist. Available for Redis only.

InvalidServerlessCacheSnapshotStateFault:

The state of the serverless cache snapshot was not received. Available for Redis only.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidARNFault:

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

Examples

Example 1: AddTagsToResource

Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.

$result = $client->addTagsToResource([
    'ResourceName' => 'arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster',
    'Tags' => [
        [
            'Key' => 'APIVersion',
            'Value' => '20150202',
        ],
        [
            'Key' => 'Service',
            'Value' => 'ElastiCache',
        ],
    ],
]);

Result syntax:

[
    'TagList' => [
        [
            'Key' => 'APIVersion',
            'Value' => '20150202',
        ],
        [
            'Key' => 'Service',
            'Value' => 'ElastiCache',
        ],
    ],
]

AuthorizeCacheSecurityGroupIngress

$result = $client->authorizeCacheSecurityGroupIngress([/* ... */]);
$promise = $client->authorizeCacheSecurityGroupIngressAsync([/* ... */]);

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

Parameter Syntax

$result = $client->authorizeCacheSecurityGroupIngress([
    'CacheSecurityGroupName' => '<string>', // REQUIRED
    'EC2SecurityGroupName' => '<string>', // REQUIRED
    'EC2SecurityGroupOwnerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CacheSecurityGroup' => [
        'ARN' => '<string>',
        'CacheSecurityGroupName' => '<string>',
        'Description' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'OwnerId' => '<string>',
    ],
]

Result Details

Errors

CacheSecurityGroupNotFoundFault:

The requested cache security group name does not refer to an existing cache security group.

InvalidCacheSecurityGroupStateFault:

The current state of the cache security group does not allow deletion.

AuthorizationAlreadyExistsFault:

The specified Amazon EC2 security group is already authorized for the specified cache security group.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: AuthorizeCacheCacheSecurityGroupIngress

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon EC2 security groups are used as the authorization mechanism.

$result = $client->authorizeCacheSecurityGroupIngress([
    'CacheSecurityGroupName' => 'my-sec-grp',
    'EC2SecurityGroupName' => 'my-ec2-sec-grp',
    'EC2SecurityGroupOwnerId' => '1234567890',
]);

BatchApplyUpdateAction

$result = $client->batchApplyUpdateAction([/* ... */]);
$promise = $client->batchApplyUpdateActionAsync([/* ... */]);

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

Parameter Syntax

$result = $client->batchApplyUpdateAction([
    'CacheClusterIds' => ['<string>', ...],
    'ReplicationGroupIds' => ['<string>', ...],
    'ServiceUpdateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProcessedUpdateActions' => [
        [
            'CacheClusterId' => '<string>',
            'ReplicationGroupId' => '<string>',
            'ServiceUpdateName' => '<string>',
            'UpdateActionStatus' => 'not-applied|waiting-to-start|in-progress|stopping|stopped|complete|scheduling|scheduled|not-applicable',
        ],
        // ...
    ],
    'UnprocessedUpdateActions' => [
        [
            'CacheClusterId' => '<string>',
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
            'ReplicationGroupId' => '<string>',
            'ServiceUpdateName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceUpdateNotFoundFault:

The service update doesn't exist

InvalidParameterValueException:

The value for a parameter is invalid.

BatchStopUpdateAction

$result = $client->batchStopUpdateAction([/* ... */]);
$promise = $client->batchStopUpdateActionAsync([/* ... */]);

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

Parameter Syntax

$result = $client->batchStopUpdateAction([
    'CacheClusterIds' => ['<string>', ...],
    'ReplicationGroupIds' => ['<string>', ...],
    'ServiceUpdateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProcessedUpdateActions' => [
        [
            'CacheClusterId' => '<string>',
            'ReplicationGroupId' => '<string>',
            'ServiceUpdateName' => '<string>',
            'UpdateActionStatus' => 'not-applied|waiting-to-start|in-progress|stopping|stopped|complete|scheduling|scheduled|not-applicable',
        ],
        // ...
    ],
    'UnprocessedUpdateActions' => [
        [
            'CacheClusterId' => '<string>',
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
            'ReplicationGroupId' => '<string>',
            'ServiceUpdateName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceUpdateNotFoundFault:

The service update doesn't exist

InvalidParameterValueException:

The value for a parameter is invalid.

CompleteMigration

$result = $client->completeMigration([/* ... */]);
$promise = $client->completeMigrationAsync([/* ... */]);

Complete the migration of data.

Parameter Syntax

$result = $client->completeMigration([
    'Force' => true || false,
    'ReplicationGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'AuthTokenLastModifiedDate' => <DateTime>,
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'ClusterMode' => 'enabled|disabled|compatible',
        'ConfigurationEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'enabled|disabled',
        'Description' => '<string>',
        'GlobalReplicationGroupInfo' => [
            'GlobalReplicationGroupId' => '<string>',
            'GlobalReplicationGroupMemberRole' => '<string>',
        ],
        'IpDiscovery' => 'ipv4|ipv6',
        'KmsKeyId' => '<string>',
        'LogDeliveryConfigurations' => [
            [
                'DestinationDetails' => [
                    'CloudWatchLogsDetails' => [
                        'LogGroup' => '<string>',
                    ],
                    'KinesisFirehoseDetails' => [
                        'DeliveryStream' => '<string>',
                    ],
                ],
                'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                'LogFormat' => 'text|json',
                'LogType' => 'slow-log|engine-log',
                'Message' => '<string>',
                'Status' => 'active|enabling|modifying|disabling|error',
            ],
            // ...
        ],
        'MemberClusters' => ['<string>', ...],
        'MemberClustersOutpostArns' => ['<string>', ...],
        'MultiAZ' => 'enabled|disabled',
        'NetworkType' => 'ipv4|ipv6|dual_stack',
        'NodeGroups' => [
            [
                'NodeGroupId' => '<string>',
                'NodeGroupMembers' => [
                    [
                        'CacheClusterId' => '<string>',
                        'CacheNodeId' => '<string>',
                        'CurrentRole' => '<string>',
                        'PreferredAvailabilityZone' => '<string>',
                        'PreferredOutpostArn' => '<string>',
                        'ReadEndpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'PrimaryEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'ReaderEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AuthTokenStatus' => 'SETTING|ROTATING',
            'AutomaticFailoverStatus' => 'enabled|disabled',
            'ClusterMode' => 'enabled|disabled|compatible',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                ],
                // ...
            ],
            'PrimaryClusterId' => '<string>',
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
            'UserGroups' => [
                'UserGroupIdsToAdd' => ['<string>', ...],
                'UserGroupIdsToRemove' => ['<string>', ...],
            ],
        ],
        'ReplicationGroupCreateTime' => <DateTime>,
        'ReplicationGroupId' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnapshottingClusterId' => '<string>',
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
        'TransitEncryptionMode' => 'preferred|required',
        'UserGroupIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

ReplicationGroupNotUnderMigrationFault:

The designated replication group is not available for data migration.

CopyServerlessCacheSnapshot

$result = $client->copyServerlessCacheSnapshot([/* ... */]);
$promise = $client->copyServerlessCacheSnapshotAsync([/* ... */]);

Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.

Parameter Syntax

$result = $client->copyServerlessCacheSnapshot([
    'KmsKeyId' => '<string>',
    'SourceServerlessCacheSnapshotName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetServerlessCacheSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServerlessCacheSnapshot' => [
        'ARN' => '<string>',
        'BytesUsedForCache' => '<string>',
        'CreateTime' => <DateTime>,
        'ExpiryTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'ServerlessCacheConfiguration' => [
            'Engine' => '<string>',
            'MajorEngineVersion' => '<string>',
            'ServerlessCacheName' => '<string>',
        ],
        'ServerlessCacheSnapshotName' => '<string>',
        'SnapshotType' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

ServerlessCacheSnapshotAlreadyExistsFault:

A serverless cache snapshot with this name already exists. Available for Redis only.

ServerlessCacheSnapshotNotFoundFault:

This serverless cache snapshot could not be found or does not exist. Available for Redis only.

ServerlessCacheSnapshotQuotaExceededFault:

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.

InvalidServerlessCacheSnapshotStateFault:

The state of the serverless cache snapshot was not received. Available for Redis only.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

CopySnapshot

$result = $client->copySnapshot([/* ... */]);
$promise = $client->copySnapshotAsync([/* ... */]);

Makes a copy of an existing snapshot.

You could receive the following error messages.

Error Messages

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

Parameter Syntax

$result = $client->copySnapshot([
    'KmsKeyId' => '<string>',
    'SourceSnapshotName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetBucket' => '<string>',
    'TargetSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Snapshot' => [
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheClusterCreateTime' => <DateTime>,
        'CacheClusterId' => '<string>',
        'CacheNodeType' => '<string>',
        'CacheParameterGroupName' => '<string>',
        'CacheSubnetGroupName' => '<string>',
        'DataTiering' => 'enabled|disabled',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'NodeSnapshots' => [
            [
                'CacheClusterId' => '<string>',
                'CacheNodeCreateTime' => <DateTime>,
                'CacheNodeId' => '<string>',
                'CacheSize' => '<string>',
                'NodeGroupConfiguration' => [
                    'NodeGroupId' => '<string>',
                    'PrimaryAvailabilityZone' => '<string>',
                    'PrimaryOutpostArn' => '<string>',
                    'ReplicaAvailabilityZones' => ['<string>', ...],
                    'ReplicaCount' => <integer>,
                    'ReplicaOutpostArns' => ['<string>', ...],
                    'Slots' => '<string>',
                ],
                'NodeGroupId' => '<string>',
                'SnapshotCreateTime' => <DateTime>,
            ],
            // ...
        ],
        'NumCacheNodes' => <integer>,
        'NumNodeGroups' => <integer>,
        'Port' => <integer>,
        'PreferredAvailabilityZone' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PreferredOutpostArn' => '<string>',
        'ReplicationGroupDescription' => '<string>',
        'ReplicationGroupId' => '<string>',
        'SnapshotName' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotSource' => '<string>',
        'SnapshotStatus' => '<string>',
        'SnapshotWindow' => '<string>',
        'TopicArn' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

SnapshotAlreadyExistsFault:

You already have a snapshot with the given name.

SnapshotNotFoundFault:

The requested snapshot name does not refer to an existing snapshot.

SnapshotQuotaExceededFault:

The request cannot be processed because it would exceed the maximum number of snapshots.

InvalidSnapshotStateFault:

The current state of the snapshot does not allow the requested operation to occur.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: CopySnapshot

Copies a snapshot to a specified name.

$result = $client->copySnapshot([
    'SourceSnapshotName' => 'my-snapshot',
    'TargetBucket' => '',
    'TargetSnapshotName' => 'my-snapshot-copy',
]);

Result syntax:

[
    'Snapshot' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterCreateTime' => ,
        'CacheClusterId' => 'my-redis4',
        'CacheNodeType' => 'cache.m3.large',
        'CacheParameterGroupName' => 'default.redis3.2',
        'CacheSubnetGroupName' => 'default',
        'Engine' => 'redis',
        'EngineVersion' => '3.2.4',
        'NodeSnapshots' => [
            [
                'CacheNodeCreateTime' => ,
                'CacheNodeId' => '0001',
                'CacheSize' => '3 MB',
                'SnapshotCreateTime' => ,
            ],
        ],
        'NumCacheNodes' => 1,
        'Port' => 6379,
        'PreferredAvailabilityZone' => 'us-east-1c',
        'PreferredMaintenanceWindow' => 'tue:09:30-tue:10:30',
        'SnapshotName' => 'my-snapshot-copy',
        'SnapshotRetentionLimit' => 7,
        'SnapshotSource' => 'manual',
        'SnapshotStatus' => 'creating',
        'SnapshotWindow' => '07:00-08:00',
        'VpcId' => 'vpc-3820329f3',
    ],
]

CreateCacheCluster

$result = $client->createCacheCluster([/* ... */]);
$promise = $client->createCacheClusterAsync([/* ... */]);

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

This operation is not supported for Redis (cluster mode enabled) clusters.

Parameter Syntax

$result = $client->createCacheCluster([
    'AZMode' => 'single-az|cross-az',
    'AuthToken' => '<string>',
    'AutoMinorVersionUpgrade' => true || false,
    'CacheClusterId' => '<string>', // REQUIRED
    'CacheNodeType' => '<string>',
    'CacheParameterGroupName' => '<string>',
    'CacheSecurityGroupNames' => ['<string>', ...],
    'CacheSubnetGroupName' => '<string>',
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'IpDiscovery' => 'ipv4|ipv6',
    'LogDeliveryConfigurations' => [
        [
            'DestinationDetails' => [
                'CloudWatchLogsDetails' => [
                    'LogGroup' => '<string>',
                ],
                'KinesisFirehoseDetails' => [
                    'DeliveryStream' => '<string>',
                ],
            ],
            'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
            'Enabled' => true || false,
            'LogFormat' => 'text|json',
            'LogType' => 'slow-log|engine-log',
        ],
        // ...
    ],
    'NetworkType' => 'ipv4|ipv6|dual_stack',
    'NotificationTopicArn' => '<string>',
    'NumCacheNodes' => <integer>,
    'OutpostMode' => 'single-outpost|cross-outpost',
    'Port' => <integer>,
    'PreferredAvailabilityZone' => '<string>',
    'PreferredAvailabilityZones' => ['<string>', ...],
    'PreferredMaintenanceWindow' => '<string>',
    'PreferredOutpostArn' => '<string>',
    'PreferredOutpostArns' => ['<string>', ...],
    'ReplicationGroupId' => '<string>',
    'SecurityGroupIds' => ['<string>', ...],
    'SnapshotArns' => ['<string>', ...],
    'SnapshotName' => '<string>',
    'SnapshotRetentionLimit' => <integer>,
    'SnapshotWindow' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransitEncryptionEnabled' => true || false,
]);

Parameter Details

Result Syntax

[
    'CacheCluster' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'AuthTokenLastModifiedDate' => <DateTime>,
        'AutoMinorVersionUpgrade' => true || false,
        'CacheClusterCreateTime' => <DateTime>,
        'CacheClusterId' => '<string>',
        'CacheClusterStatus' => '<string>',
        'CacheNodeType' => '<string>',
        'CacheNodes' => [
            [
                'CacheNodeCreateTime' => <DateTime>,
                'CacheNodeId' => '<string>',
                'CacheNodeStatus' => '<string>',
                'CustomerAvailabilityZone' => '<string>',
                'CustomerOutpostArn' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'ParameterGroupStatus' => '<string>',
                'SourceCacheNodeId' => '<string>',
            ],
            // ...
        ],
        'CacheParameterGroup' => [
            'CacheNodeIdsToReboot' => ['<string>', ...],
            'CacheParameterGroupName' => '<string>',
            'ParameterApplyStatus' => '<string>',
        ],
        'CacheSecurityGroups' => [
            [
                'CacheSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'CacheSubnetGroupName' => '<string>',
        'ClientDownloadLandingPage' => '<string>',
        'ConfigurationEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'IpDiscovery' => 'ipv4|ipv6',
        'LogDeliveryConfigurations' => [
            [
                'DestinationDetails' => [
                    'CloudWatchLogsDetails' => [
                        'LogGroup' => '<string>',
                    ],
                    'KinesisFirehoseDetails' => [
                        'DeliveryStream' => '<string>',
                    ],
                ],
                'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                'LogFormat' => 'text|json',
                'LogType' => 'slow-log|engine-log',
                'Message' => '<string>',
                'Status' => 'active|enabling|modifying|disabling|error',
            ],
            // ...
        ],
        'NetworkType' => 'ipv4|ipv6|dual_stack',
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'NumCacheNodes' => <integer>,
        'PendingModifiedValues' => [
            'AuthTokenStatus' => 'SETTING|ROTATING',
            'CacheNodeIdsToRemove' => ['<string>', ...],
            'CacheNodeType' => '<string>',
            'EngineVersion' => '<string>',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                ],
                // ...
            ],
            'NumCacheNodes' => <integer>,
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
        ],
        'PreferredAvailabilityZone' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PreferredOutpostArn' => '<string>',
        'ReplicationGroupId' => '<string>',
        'ReplicationGroupLogDeliveryEnabled' => true || false,
        'SecurityGroups' => [
            [
                'SecurityGroupId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'TransitEncryptionEnabled' => true || false,
        'TransitEncryptionMode' => 'preferred|required',
    ],
]

Result Details

Errors

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

CacheClusterAlreadyExistsFault:

You already have a cluster with the given identifier.

InsufficientCacheClusterCapacityFault:

The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

CacheSecurityGroupNotFoundFault:

The requested cache security group name does not refer to an existing cache security group.

CacheSubnetGroupNotFoundFault:

The requested cache subnet group name does not refer to an existing cache subnet group.

ClusterQuotaForCustomerExceededFault:

The request cannot be processed because it would exceed the allowed number of clusters per customer.

NodeQuotaForClusterExceededFault:

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

NodeQuotaForCustomerExceededFault:

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheParameterGroupNotFoundFault:

The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidVPCNetworkStateFault:

The VPC network is in an invalid state.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: CreateCacheCluster

Creates a Memcached cluster with 2 nodes.

$result = $client->createCacheCluster([
    'AZMode' => 'cross-az',
    'CacheClusterId' => 'my-memcached-cluster',
    'CacheNodeType' => 'cache.r3.large',
    'CacheSubnetGroupName' => 'default',
    'Engine' => 'memcached',
    'EngineVersion' => '1.4.24',
    'NumCacheNodes' => 2,
    'Port' => 11211,
]);

Result syntax:

[
    'CacheCluster' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterId' => 'my-memcached-cluster',
        'CacheClusterStatus' => 'creating',
        'CacheNodeType' => 'cache.r3.large',
        'CacheParameterGroup' => [
            'CacheNodeIdsToReboot' => [
            ],
            'CacheParameterGroupName' => 'default.memcached1.4',
            'ParameterApplyStatus' => 'in-sync',
        ],
        'CacheSecurityGroups' => [
        ],
        'CacheSubnetGroupName' => 'default',
        'ClientDownloadLandingPage' => 'https://console.aws.amazon.com/elasticache/home#client-download:',
        'Engine' => 'memcached',
        'EngineVersion' => '1.4.24',
        'NumCacheNodes' => 2,
        'PendingModifiedValues' => [
        ],
        'PreferredAvailabilityZone' => 'Multiple',
        'PreferredMaintenanceWindow' => 'wed:09:00-wed:10:00',
    ],
]

Example 2: CreateCacheCluster

Creates a Redis cluster with 1 node.

$result = $client->createCacheCluster([
    'AutoMinorVersionUpgrade' => 1,
    'CacheClusterId' => 'my-redis',
    'CacheNodeType' => 'cache.r3.larage',
    'CacheSubnetGroupName' => 'default',
    'Engine' => 'redis',
    'EngineVersion' => '3.2.4',
    'NumCacheNodes' => 1,
    'Port' => 6379,
    'PreferredAvailabilityZone' => 'us-east-1c',
    'SnapshotRetentionLimit' => 7,
]);

Result syntax:

[
    'CacheCluster' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterId' => 'my-redis',
        'CacheClusterStatus' => 'creating',
        'CacheNodeType' => 'cache.m3.large',
        'CacheParameterGroup' => [
            'CacheNodeIdsToReboot' => [
            ],
            'CacheParameterGroupName' => 'default.redis3.2',
            'ParameterApplyStatus' => 'in-sync',
        ],
        'CacheSecurityGroups' => [
        ],
        'CacheSubnetGroupName' => 'default',
        'ClientDownloadLandingPage' => 'https: //console.aws.amazon.com/elasticache/home#client-download: ',
        'Engine' => 'redis',
        'EngineVersion' => '3.2.4',
        'NumCacheNodes' => 1,
        'PendingModifiedValues' => [
        ],
        'PreferredAvailabilityZone' => 'us-east-1c',
        'PreferredMaintenanceWindow' => 'fri: 05: 30-fri: 06: 30',
        'SnapshotRetentionLimit' => 7,
        'SnapshotWindow' => '10: 00-11: 00',
    ],
]

CreateCacheParameterGroup

$result = $client->createCacheParameterGroup([/* ... */]);
$promise = $client->createCacheParameterGroupAsync([/* ... */]);

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

• ModifyCacheParameterGroup in the ElastiCache API Reference.

• Parameters and Parameter Groups in the ElastiCache User Guide.

Parameter Syntax

$result = $client->createCacheParameterGroup([
    'CacheParameterGroupFamily' => '<string>', // REQUIRED
    'CacheParameterGroupName' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CacheParameterGroup' => [
        'ARN' => '<string>',
        'CacheParameterGroupFamily' => '<string>',
        'CacheParameterGroupName' => '<string>',
        'Description' => '<string>',
        'IsGlobal' => true || false,
    ],
]

Result Details

Errors

CacheParameterGroupQuotaExceededFault:

The request cannot be processed because it would exceed the maximum number of cache security groups.

CacheParameterGroupAlreadyExistsFault:

A cache parameter group with the requested name already exists.

InvalidCacheParameterGroupStateFault:

The current state of the cache parameter group does not allow the requested operation to occur.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: CreateCacheParameterGroup

Creates the Amazon ElastiCache parameter group custom-redis2-8.

$result = $client->createCacheParameterGroup([
    'CacheParameterGroupFamily' => 'redis2.8',
    'CacheParameterGroupName' => 'custom-redis2-8',
    'Description' => 'Custom Redis 2.8 parameter group.',
]);

Result syntax:

[
    'CacheParameterGroup' => [
        'CacheParameterGroupFamily' => 'redis2.8',
        'CacheParameterGroupName' => 'custom-redis2-8',
        'Description' => 'Custom Redis 2.8 parameter group.',
    ],
]

CreateCacheSecurityGroup

$result = $client->createCacheSecurityGroup([/* ... */]);
$promise = $client->createCacheSecurityGroupAsync([/* ... */]);

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

Parameter Syntax

$result = $client->createCacheSecurityGroup([
    'CacheSecurityGroupName' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CacheSecurityGroup' => [
        'ARN' => '<string>',
        'CacheSecurityGroupName' => '<string>',
        'Description' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'OwnerId' => '<string>',
    ],
]

Result Details

Errors

CacheSecurityGroupAlreadyExistsFault:

A cache security group with the specified name already exists.

CacheSecurityGroupQuotaExceededFault:

The request cannot be processed because it would exceed the allowed number of cache security groups.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: CreateCacheSecurityGroup

Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.

$result = $client->createCacheSecurityGroup([
    'CacheSecurityGroupName' => 'my-cache-sec-grp',
    'Description' => 'Example ElastiCache security group.',
]);

CreateCacheSubnetGroup

$result = $client->createCacheSubnetGroup([/* ... */]);
$promise = $client->createCacheSubnetGroupAsync([/* ... */]);

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

Parameter Syntax

$result = $client->createCacheSubnetGroup([
    'CacheSubnetGroupDescription' => '<string>', // REQUIRED
    'CacheSubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CacheSubnetGroup' => [
        'ARN' => '<string>',
        'CacheSubnetGroupDescription' => '<string>',
        'CacheSubnetGroupName' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetOutpost' => [
                    'SubnetOutpostArn' => '<string>',
                ],
                'SupportedNetworkTypes' => ['<string>', ...],
            ],
            // ...
        ],
        'SupportedNetworkTypes' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

CacheSubnetGroupAlreadyExistsFault:

The requested cache subnet group name is already in use by an existing cache subnet group.

CacheSubnetGroupQuotaExceededFault:

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

CacheSubnetQuotaExceededFault:

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidSubnet:

An invalid subnet identifier was specified.

SubnetNotAllowedFault:

At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.

Examples

Example 1: CreateCacheSubnet

Creates a new cache subnet group.

$result = $client->createCacheSubnetGroup([
    'CacheSubnetGroupDescription' => 'Sample subnet group',
    'CacheSubnetGroupName' => 'my-sn-grp2',
    'SubnetIds' => [
        'subnet-6f28c982',
        'subnet-bcd382f3',
        'subnet-845b3e7c0',
    ],
]);

Result syntax:

[
    'CacheSubnetGroup' => [
        'CacheSubnetGroupDescription' => 'My subnet group.',
        'CacheSubnetGroupName' => 'my-sn-grp',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => 'us-east-1a',
                ],
                'SubnetIdentifier' => 'subnet-6f28c982',
            ],
            [
                'SubnetAvailabilityZone' => [
                    'Name' => 'us-east-1c',
                ],
                'SubnetIdentifier' => 'subnet-bcd382f3',
            ],
            [
                'SubnetAvailabilityZone' => [
                    'Name' => 'us-east-1b',
                ],
                'SubnetIdentifier' => 'subnet-845b3e7c0',
            ],
        ],
        'VpcId' => 'vpc-91280df6',
    ],
]

CreateGlobalReplicationGroup

$result = $client->createGlobalReplicationGroup([/* ... */]);
$promise = $client->createGlobalReplicationGroupAsync([/* ... */]);

Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.

• The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

• The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

Parameter Syntax

$result = $client->createGlobalReplicationGroup([
    'GlobalReplicationGroupDescription' => '<string>',
    'GlobalReplicationGroupIdSuffix' => '<string>', // REQUIRED
    'PrimaryReplicationGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GlobalReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalNodeGroups' => [
            [
                'GlobalNodeGroupId' => '<string>',
                'Slots' => '<string>',
            ],
            // ...
        ],
        'GlobalReplicationGroupDescription' => '<string>',
        'GlobalReplicationGroupId' => '<string>',
        'Members' => [
            [
                'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
                'ReplicationGroupId' => '<string>',
                'ReplicationGroupRegion' => '<string>',
                'Role' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
    ],
]

Result Details

Errors

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

GlobalReplicationGroupAlreadyExistsFault:

The Global datastore name already exists.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

InvalidParameterValueException:

The value for a parameter is invalid.

CreateReplicationGroup

$result = $client->createReplicationGroup([/* ... */]);
$promise = $client->createReplicationGroupAsync([/* ... */]);

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

A Redis (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

Parameter Syntax

$result = $client->createReplicationGroup([
    'AtRestEncryptionEnabled' => true || false,
    'AuthToken' => '<string>',
    'AutoMinorVersionUpgrade' => true || false,
    'AutomaticFailoverEnabled' => true || false,
    'CacheNodeType' => '<string>',
    'CacheParameterGroupName' => '<string>',
    'CacheSecurityGroupNames' => ['<string>', ...],
    'CacheSubnetGroupName' => '<string>',
    'ClusterMode' => 'enabled|disabled|compatible',
    'DataTieringEnabled' => true || false,
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'GlobalReplicationGroupId' => '<string>',
    'IpDiscovery' => 'ipv4|ipv6',
    'KmsKeyId' => '<string>',
    'LogDeliveryConfigurations' => [
        [
            'DestinationDetails' => [
                'CloudWatchLogsDetails' => [
                    'LogGroup' => '<string>',
                ],
                'KinesisFirehoseDetails' => [
                    'DeliveryStream' => '<string>',
                ],
            ],
            'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
            'Enabled' => true || false,
            'LogFormat' => 'text|json',
            'LogType' => 'slow-log|engine-log',
        ],
        // ...
    ],
    'MultiAZEnabled' => true || false,
    'NetworkType' => 'ipv4|ipv6|dual_stack',
    'NodeGroupConfiguration' => [
        [
            'NodeGroupId' => '<string>',
            'PrimaryAvailabilityZone' => '<string>',
            'PrimaryOutpostArn' => '<string>',
            'ReplicaAvailabilityZones' => ['<string>', ...],
            'ReplicaCount' => <integer>,
            'ReplicaOutpostArns' => ['<string>', ...],
            'Slots' => '<string>',
        ],
        // ...
    ],
    'NotificationTopicArn' => '<string>',
    'NumCacheClusters' => <integer>,
    'NumNodeGroups' => <integer>,
    'Port' => <integer>,
    'PreferredCacheClusterAZs' => ['<string>', ...],
    'PreferredMaintenanceWindow' => '<string>',
    'PrimaryClusterId' => '<string>',
    'ReplicasPerNodeGroup' => <integer>,
    'ReplicationGroupDescription' => '<string>', // REQUIRED
    'ReplicationGroupId' => '<string>', // REQUIRED
    'SecurityGroupIds' => ['<string>', ...],
    'ServerlessCacheSnapshotName' => '<string>',
    'SnapshotArns' => ['<string>', ...],
    'SnapshotName' => '<string>',
    'SnapshotRetentionLimit' => <integer>,
    'SnapshotWindow' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransitEncryptionEnabled' => true || false,
    'TransitEncryptionMode' => 'preferred|required',
    'UserGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'AuthTokenLastModifiedDate' => <DateTime>,
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'ClusterMode' => 'enabled|disabled|compatible',
        'ConfigurationEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'enabled|disabled',
        'Description' => '<string>',
        'GlobalReplicationGroupInfo' => [
            'GlobalReplicationGroupId' => '<string>',
            'GlobalReplicationGroupMemberRole' => '<string>',
        ],
        'IpDiscovery' => 'ipv4|ipv6',
        'KmsKeyId' => '<string>',
        'LogDeliveryConfigurations' => [
            [
                'DestinationDetails' => [
                    'CloudWatchLogsDetails' => [
                        'LogGroup' => '<string>',
                    ],
                    'KinesisFirehoseDetails' => [
                        'DeliveryStream' => '<string>',
                    ],
                ],
                'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                'LogFormat' => 'text|json',
                'LogType' => 'slow-log|engine-log',
                'Message' => '<string>',
                'Status' => 'active|enabling|modifying|disabling|error',
            ],
            // ...
        ],
        'MemberClusters' => ['<string>', ...],
        'MemberClustersOutpostArns' => ['<string>', ...],
        'MultiAZ' => 'enabled|disabled',
        'NetworkType' => 'ipv4|ipv6|dual_stack',
        'NodeGroups' => [
            [
                'NodeGroupId' => '<string>',
                'NodeGroupMembers' => [
                    [
                        'CacheClusterId' => '<string>',
                        'CacheNodeId' => '<string>',
                        'CurrentRole' => '<string>',
                        'PreferredAvailabilityZone' => '<string>',
                        'PreferredOutpostArn' => '<string>',
                        'ReadEndpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'PrimaryEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'ReaderEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AuthTokenStatus' => 'SETTING|ROTATING',
            'AutomaticFailoverStatus' => 'enabled|disabled',
            'ClusterMode' => 'enabled|disabled|compatible',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                ],
                // ...
            ],
            'PrimaryClusterId' => '<string>',
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
            'UserGroups' => [
                'UserGroupIdsToAdd' => ['<string>', ...],
                'UserGroupIdsToRemove' => ['<string>', ...],
            ],
        ],
        'ReplicationGroupCreateTime' => <DateTime>,
        'ReplicationGroupId' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnapshottingClusterId' => '<string>',
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
        'TransitEncryptionMode' => 'preferred|required',
        'UserGroupIds' => ['<string>', ...],
    ],
]

Result Details

Errors

CacheClusterNotFoundFault:

The requested cluster ID does not refer to an existing cluster.

InvalidCacheClusterStateFault:

The requested cluster is not in the available state.

ReplicationGroupAlreadyExistsFault:

The specified replication group already exists.

InvalidUserGroupStateFault:

The user group is not in an active state.

UserGroupNotFoundFault:

The user group was not found or does not exist

InsufficientCacheClusterCapacityFault:

The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

CacheSecurityGroupNotFoundFault:

The requested cache security group name does not refer to an existing cache security group.

CacheSubnetGroupNotFoundFault:

The requested cache subnet group name does not refer to an existing cache subnet group.

ClusterQuotaForCustomerExceededFault:

The request cannot be processed because it would exceed the allowed number of clusters per customer.

NodeQuotaForClusterExceededFault:

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

NodeQuotaForCustomerExceededFault:

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheParameterGroupNotFoundFault:

The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidVPCNetworkStateFault:

The VPC network is in an invalid state.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

NodeGroupsPerReplicationGroupQuotaExceededFault:

The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90

GlobalReplicationGroupNotFoundFault:

The Global datastore does not exist

InvalidGlobalReplicationGroupStateFault:

The Global datastore is not available or in primary-only state.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: CreateCacheReplicationGroup

Creates a Redis replication group with 3 nodes.

$result = $client->createReplicationGroup([
    'AutomaticFailoverEnabled' => 1,
    'CacheNodeType' => 'cache.m3.medium',
    'Engine' => 'redis',
    'EngineVersion' => '2.8.24',
    'NumCacheClusters' => 3,
    'ReplicationGroupDescription' => 'A Redis replication group.',
    'ReplicationGroupId' => 'my-redis-rg',
    'SnapshotRetentionLimit' => 30,
]);

Result syntax:

[
    'ReplicationGroup' => [
        'AutomaticFailover' => 'enabling',
        'Description' => 'A Redis replication group.',
        'MemberClusters' => [
            'my-redis-rg-001',
            'my-redis-rg-002',
            'my-redis-rg-003',
        ],
        'PendingModifiedValues' => [
        ],
        'ReplicationGroupId' => 'my-redis-rg',
        'SnapshottingClusterId' => 'my-redis-rg-002',
        'Status' => 'creating',
    ],
]

Example 2: CreateReplicationGroup

Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.

$result = $client->createReplicationGroup([
    'AutoMinorVersionUpgrade' => 1,
    'CacheNodeType' => 'cache.m3.medium',
    'CacheParameterGroupName' => 'default.redis3.2.cluster.on',
    'Engine' => 'redis',
    'EngineVersion' => '3.2.4',
    'NodeGroupConfiguration' => [
        [
            'PrimaryAvailabilityZone' => 'us-east-1c',
            'ReplicaAvailabilityZones' => [
                'us-east-1b',
            ],
            'ReplicaCount' => 1,
            'Slots' => '0-8999',
        ],
        [
            'PrimaryAvailabilityZone' => 'us-east-1a',
            'ReplicaAvailabilityZones' => [
                'us-east-1a',
                'us-east-1c',
            ],
            'ReplicaCount' => 2,
            'Slots' => '9000-16383',
        ],
    ],
    'NumNodeGroups' => 2,
    'ReplicationGroupDescription' => 'A multi-sharded replication group',
    'ReplicationGroupId' => 'clustered-redis-rg',
    'SnapshotRetentionLimit' => 8,
]);

Result syntax:

[
    'ReplicationGroup' => [
        'AutomaticFailover' => 'enabled',
        'Description' => 'Sharded replication group',
        'MemberClusters' => [
            'rc-rg3-0001-001',
            'rc-rg3-0001-002',
            'rc-rg3-0002-001',
            'rc-rg3-0002-002',
            'rc-rg3-0002-003',
        ],
        'PendingModifiedValues' => [
        ],
        'ReplicationGroupId' => 'clustered-redis-rg',
        'SnapshotRetentionLimit' => 8,
        'SnapshotWindow' => '05:30-06:30',
        'Status' => 'creating',
    ],
]

CreateServerlessCache

$result = $client->createServerlessCache([/* ... */]);
$promise = $client->createServerlessCacheAsync([/* ... */]);

Creates a serverless cache.

Parameter Syntax

$result = $client->createServerlessCache([
    'CacheUsageLimits' => [
        'DataStorage' => [
            'Maximum' => <integer>,
            'Minimum' => <integer>,
            'Unit' => 'GB', // REQUIRED
        ],
        'ECPUPerSecond' => [
            'Maximum' => <integer>,
            'Minimum' => <integer>,
        ],
    ],
    'DailySnapshotTime' => '<string>',
    'Description' => '<string>',
    'Engine' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>',
    'MajorEngineVersion' => '<string>',
    'SecurityGroupIds' => ['<string>', ...],
    'ServerlessCacheName' => '<string>', // REQUIRED
    'SnapshotArnsToRestore' => ['<string>', ...],
    'SnapshotRetentionLimit' => <integer>,
    'SubnetIds' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserGroupId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ServerlessCache' => [
        'ARN' => '<string>',
        'CacheUsageLimits' => [
            'DataStorage' => [
                'Maximum' => <integer>,
                'Minimum' => <integer>,
                'Unit' => 'GB',
            ],
            'ECPUPerSecond' => [
                'Maximum' => <integer>,
                'Minimum' => <integer>,
            ],
        ],
        'CreateTime' => <DateTime>,
        'DailySnapshotTime' => '<string>',
        'Description' => '<string>',
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'FullEngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MajorEngineVersion' => '<string>',
        'ReaderEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'SecurityGroupIds' => ['<string>', ...],
        'ServerlessCacheName' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'Status' => '<string>',
        'SubnetIds' => ['<string>', ...],
        'UserGroupId' => '<string>',
    ],
]

Result Details

Errors

ServerlessCacheNotFoundFault:

The serverless cache was not found or does not exist.

InvalidServerlessCacheStateFault:

The account for these credentials is not currently active.

ServerlessCacheAlreadyExistsFault:

A serverless cache with this name already exists.

ServerlessCacheQuotaForCustomerExceededFault:

The number of serverless caches exceeds the customer quota.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

InvalidCredentialsException:

You must enter valid credentials.

InvalidUserGroupStateFault:

The user group is not in an active state.

UserGroupNotFoundFault:

The user group was not found or does not exist

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

CreateServerlessCacheSnapshot

$result = $client->createServerlessCacheSnapshot([/* ... */]);
$promise = $client->createServerlessCacheSnapshotAsync([/* ... */]);

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.

Parameter Syntax

$result = $client->createServerlessCacheSnapshot([
    'KmsKeyId' => '<string>',
    'ServerlessCacheName' => '<string>', // REQUIRED
    'ServerlessCacheSnapshotName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ServerlessCacheSnapshot' => [
        'ARN' => '<string>',
        'BytesUsedForCache' => '<string>',
        'CreateTime' => <DateTime>,
        'ExpiryTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'ServerlessCacheConfiguration' => [
            'Engine' => '<string>',
            'MajorEngineVersion' => '<string>',
            'ServerlessCacheName' => '<string>',
        ],
        'ServerlessCacheSnapshotName' => '<string>',
        'SnapshotType' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

ServerlessCacheSnapshotAlreadyExistsFault:

A serverless cache snapshot with this name already exists. Available for Redis only.

ServerlessCacheNotFoundFault:

The serverless cache was not found or does not exist.

InvalidServerlessCacheStateFault:

The account for these credentials is not currently active.

ServerlessCacheSnapshotQuotaExceededFault:

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

CreateSnapshot

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

Creates a copy of an entire cluster or replication group at a specific moment in time.

Parameter Syntax

$result = $client->createSnapshot([
    'CacheClusterId' => '<string>',
    'KmsKeyId' => '<string>',
    'ReplicationGroupId' => '<string>',
    'SnapshotName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Snapshot' => [
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheClusterCreateTime' => <DateTime>,
        'CacheClusterId' => '<string>',
        'CacheNodeType' => '<string>',
        'CacheParameterGroupName' => '<string>',
        'CacheSubnetGroupName' => '<string>',
        'DataTiering' => 'enabled|disabled',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'NodeSnapshots' => [
            [
                'CacheClusterId' => '<string>',
                'CacheNodeCreateTime' => <DateTime>,
                'CacheNodeId' => '<string>',
                'CacheSize' => '<string>',
                'NodeGroupConfiguration' => [
                    'NodeGroupId' => '<string>',
                    'PrimaryAvailabilityZone' => '<string>',
                    'PrimaryOutpostArn' => '<string>',
                    'ReplicaAvailabilityZones' => ['<string>', ...],
                    'ReplicaCount' => <integer>,
                    'ReplicaOutpostArns' => ['<string>', ...],
                    'Slots' => '<string>',
                ],
                'NodeGroupId' => '<string>',
                'SnapshotCreateTime' => <DateTime>,
            ],
            // ...
        ],
        'NumCacheNodes' => <integer>,
        'NumNodeGroups' => <integer>,
        'Port' => <integer>,
        'PreferredAvailabilityZone' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PreferredOutpostArn' => '<string>',
        'ReplicationGroupDescription' => '<string>',
        'ReplicationGroupId' => '<string>',
        'SnapshotName' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotSource' => '<string>',
        'SnapshotStatus' => '<string>',
        'SnapshotWindow' => '<string>',
        'TopicArn' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

SnapshotAlreadyExistsFault:

You already have a snapshot with the given name.

CacheClusterNotFoundFault:

The requested cluster ID does not refer to an existing cluster.

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidCacheClusterStateFault:

The requested cluster is not in the available state.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

SnapshotQuotaExceededFault:

The request cannot be processed because it would exceed the maximum number of snapshots.

SnapshotFeatureNotSupportedFault:

You attempted one of the following operations:

• Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.

• Creating a snapshot of a cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

InvalidParameterValueException:

The value for a parameter is invalid.

Examples

Example 1: CreateSnapshot - NonClustered Redis, no read-replicas

Creates a snapshot of a non-clustered Redis cluster that has only one node.

$result = $client->createSnapshot([
    'CacheClusterId' => 'onenoderedis',
    'SnapshotName' => 'snapshot-1',
]);

Result syntax:

[
    'Snapshot' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterCreateTime' => ,
        'CacheClusterId' => 'onenoderedis',
        'CacheNodeType' => 'cache.m3.medium',
        'CacheParameterGroupName' => 'default.redis3.2',
        'CacheSubnetGroupName' => 'default',
        'Engine' => 'redis',
        'EngineVersion' => '3.2.4',
        'NodeSnapshots' => [
            [
                'CacheNodeCreateTime' => ,
                'CacheNodeId' => '0001',
                'CacheSize' => '',
            ],
        ],
        'NumCacheNodes' => 1,
        'Port' => 6379,
        'PreferredAvailabilityZone' => 'us-west-2c',
        'PreferredMaintenanceWindow' => 'sat:08:00-sat:09:00',
        'SnapshotName' => 'snapshot-1',
        'SnapshotRetentionLimit' => 1,
        'SnapshotSource' => 'manual',
        'SnapshotStatus' => 'creating',
        'SnapshotWindow' => '00:00-01:00',
        'VpcId' => 'vpc-73c3cd17',
    ],
]

Example 2: CreateSnapshot - NonClustered Redis, 2 read-replicas

Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas. CacheClusterId must be a specific node in the cluster.

$result = $client->createSnapshot([
    'CacheClusterId' => 'threenoderedis-001',
    'SnapshotName' => 'snapshot-2',
]);

Result syntax:

[
    'Snapshot' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterCreateTime' => ,
        'CacheClusterId' => 'threenoderedis-001',
        'CacheNodeType' => 'cache.m3.medium',
        'CacheParameterGroupName' => 'default.redis3.2',
        'CacheSubnetGroupName' => 'default',
        'Engine' => 'redis',
        'EngineVersion' => '3.2.4',
        'NodeSnapshots' => [
            [
                'CacheNodeCreateTime' => ,
                'CacheNodeId' => '0001',
                'CacheSize' => '',
            ],
        ],
        'NumCacheNodes' => 1,
        'Port' => 6379,
        'PreferredAvailabilityZone' => 'us-west-2c',
        'PreferredMaintenanceWindow' => 'sat:08:00-sat:09:00',
        'SnapshotName' => 'snapshot-2',
        'SnapshotRetentionLimit' => 1,
        'SnapshotSource' => 'manual',
        'SnapshotStatus' => 'creating',
        'SnapshotWindow' => '00:00-01:00',
        'VpcId' => 'vpc-73c3cd17',
    ],
]

Example 3: CreateSnapshot-clustered Redis

Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.

$result = $client->createSnapshot([
    'ReplicationGroupId' => 'clusteredredis',
    'SnapshotName' => 'snapshot-2x5',
]);

Result syntax:

[
    'Snapshot' => [
        'AutoMinorVersionUpgrade' => 1,
        'AutomaticFailover' => 'enabled',
        'CacheNodeType' => 'cache.m3.medium',
        'CacheParameterGroupName' => 'default.redis3.2.cluster.on',
        'CacheSubnetGroupName' => 'default',
        'Engine' => 'redis',
        'EngineVersion' => '3.2.4',
        'NodeSnapshots' => [
            [
                'CacheSize' => '',
                'NodeGroupId' => '0001',
            ],
            [
                'CacheSize' => '',
                'NodeGroupId' => '0002',
            ],
        ],
        'NumNodeGroups' => 2,
        'Port' => 6379,
        'PreferredMaintenanceWindow' => 'mon:09:30-mon:10:30',
        'ReplicationGroupDescription' => 'Redis cluster with 2 shards.',
        'ReplicationGroupId' => 'clusteredredis',
        'SnapshotName' => 'snapshot-2x5',
        'SnapshotRetentionLimit' => 1,
        'SnapshotSource' => 'manual',
        'SnapshotStatus' => 'creating',
        'SnapshotWindow' => '12:00-13:00',
        'VpcId' => 'vpc-73c3cd17',
    ],
]

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

Parameter Syntax

$result = $client->createUser([
    'AccessString' => '<string>', // REQUIRED
    'AuthenticationMode' => [
        'Passwords' => ['<string>', ...],
        'Type' => 'password|no-password-required|iam',
    ],
    'Engine' => '<string>', // REQUIRED
    'NoPasswordRequired' => true || false,
    'Passwords' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ARN' => '<string>',
    'AccessString' => '<string>',
    'Authentication' => [
        'PasswordCount' => <integer>,
        'Type' => 'password|no-password|iam',
    ],
    'Engine' => '<string>',
    'MinimumEngineVersion' => '<string>',
    'Status' => '<string>',
    'UserGroupIds' => ['<string>', ...],
    'UserId' => '<string>',
    'UserName' => '<string>',
]

Result Details

Errors

UserAlreadyExistsFault:

A user with this ID already exists.

UserQuotaExceededFault:

The quota of users has been exceeded.

DuplicateUserNameFault:

A user with this username already exists.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

CreateUserGroup

$result = $client->createUserGroup([/* ... */]);
$promise = $client->createUserGroupAsync([/* ... */]);

For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)

Parameter Syntax

$result = $client->createUserGroup([
    'Engine' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserGroupId' => '<string>', // REQUIRED
    'UserIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ARN' => '<string>',
    'Engine' => '<string>',
    'MinimumEngineVersion' => '<string>',
    'PendingChanges' => [
        'UserIdsToAdd' => ['<string>', ...],
        'UserIdsToRemove' => ['<string>', ...],
    ],
    'ReplicationGroups' => ['<string>', ...],
    'ServerlessCaches' => ['<string>', ...],
    'Status' => '<string>',
    'UserGroupId' => '<string>',
    'UserIds' => ['<string>', ...],
]

Result Details

Errors

UserNotFoundFault:

The user does not exist or could not be found.

DuplicateUserNameFault:

A user with this username already exists.

UserGroupAlreadyExistsFault:

The user group with this ID already exists.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

DefaultUserRequired:

You must add default user to a user group.

UserGroupQuotaExceededFault:

The number of users exceeds the user group limit.

InvalidParameterValueException:

The value for a parameter is invalid.

TagQuotaPerResourceExceeded:

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

DecreaseNodeGroupsInGlobalReplicationGroup

$result = $client->decreaseNodeGroupsInGlobalReplicationGroup([/* ... */]);
$promise = $client->decreaseNodeGroupsInGlobalReplicationGroupAsync([/* ... */]);

Decreases the number of node groups in a Global datastore

Parameter Syntax

$result = $client->decreaseNodeGroupsInGlobalReplicationGroup([
    'ApplyImmediately' => true || false, // REQUIRED
    'GlobalNodeGroupsToRemove' => ['<string>', ...],
    'GlobalNodeGroupsToRetain' => ['<string>', ...],
    'GlobalReplicationGroupId' => '<string>', // REQUIRED
    'NodeGroupCount' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GlobalReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalNodeGroups' => [
            [
                'GlobalNodeGroupId' => '<string>',
                'Slots' => '<string>',
            ],
            // ...
        ],
        'GlobalReplicationGroupDescription' => '<string>',
        'GlobalReplicationGroupId' => '<string>',
        'Members' => [
            [
                'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
                'ReplicationGroupId' => '<string>',
                'ReplicationGroupRegion' => '<string>',
                'Role' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
    ],
]

Result Details

Errors

GlobalReplicationGroupNotFoundFault:

The Global datastore does not exist

InvalidGlobalReplicationGroupStateFault:

The Global datastore is not available or in primary-only state.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DecreaseReplicaCount

$result = $client->decreaseReplicaCount([/* ... */]);
$promise = $client->decreaseReplicaCountAsync([/* ... */]);

Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Parameter Syntax

$result = $client->decreaseReplicaCount([
    'ApplyImmediately' => true || false, // REQUIRED
    'NewReplicaCount' => <integer>,
    'ReplicaConfiguration' => [
        [
            'NewReplicaCount' => <integer>, // REQUIRED
            'NodeGroupId' => '<string>', // REQUIRED
            'PreferredAvailabilityZones' => ['<string>', ...],
            'PreferredOutpostArns' => ['<string>', ...],
        ],
        // ...
    ],
    'ReplicasToRemove' => ['<string>', ...],
    'ReplicationGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'AuthTokenLastModifiedDate' => <DateTime>,
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'ClusterMode' => 'enabled|disabled|compatible',
        'ConfigurationEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'enabled|disabled',
        'Description' => '<string>',
        'GlobalReplicationGroupInfo' => [
            'GlobalReplicationGroupId' => '<string>',
            'GlobalReplicationGroupMemberRole' => '<string>',
        ],
        'IpDiscovery' => 'ipv4|ipv6',
        'KmsKeyId' => '<string>',
        'LogDeliveryConfigurations' => [
            [
                'DestinationDetails' => [
                    'CloudWatchLogsDetails' => [
                        'LogGroup' => '<string>',
                    ],
                    'KinesisFirehoseDetails' => [
                        'DeliveryStream' => '<string>',
                    ],
                ],
                'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                'LogFormat' => 'text|json',
                'LogType' => 'slow-log|engine-log',
                'Message' => '<string>',
                'Status' => 'active|enabling|modifying|disabling|error',
            ],
            // ...
        ],
        'MemberClusters' => ['<string>', ...],
        'MemberClustersOutpostArns' => ['<string>', ...],
        'MultiAZ' => 'enabled|disabled',
        'NetworkType' => 'ipv4|ipv6|dual_stack',
        'NodeGroups' => [
            [
                'NodeGroupId' => '<string>',
                'NodeGroupMembers' => [
                    [
                        'CacheClusterId' => '<string>',
                        'CacheNodeId' => '<string>',
                        'CurrentRole' => '<string>',
                        'PreferredAvailabilityZone' => '<string>',
                        'PreferredOutpostArn' => '<string>',
                        'ReadEndpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'PrimaryEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'ReaderEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AuthTokenStatus' => 'SETTING|ROTATING',
            'AutomaticFailoverStatus' => 'enabled|disabled',
            'ClusterMode' => 'enabled|disabled|compatible',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                ],
                // ...
            ],
            'PrimaryClusterId' => '<string>',
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
            'UserGroups' => [
                'UserGroupIdsToAdd' => ['<string>', ...],
                'UserGroupIdsToRemove' => ['<string>', ...],
            ],
        ],
        'ReplicationGroupCreateTime' => <DateTime>,
        'ReplicationGroupId' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnapshottingClusterId' => '<string>',
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
        'TransitEncryptionMode' => 'preferred|required',
        'UserGroupIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

InvalidCacheClusterStateFault:

The requested cluster is not in the available state.

InvalidVPCNetworkStateFault:

The VPC network is in an invalid state.

InsufficientCacheClusterCapacityFault:

The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

ClusterQuotaForCustomerExceededFault:

The request cannot be processed because it would exceed the allowed number of clusters per customer.

NodeGroupsPerReplicationGroupQuotaExceededFault:

The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90

NodeQuotaForCustomerExceededFault:

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

NoOperationFault:

The operation was not performed because no changes were required.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DeleteCacheCluster

$result = $client->deleteCacheCluster([/* ... */]);
$promise = $client->deleteCacheClusterAsync([/* ... */]);

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

• Redis (cluster mode enabled) clusters

• Redis (cluster mode disabled) clusters

• A cluster that is the last read replica of a replication group

• A cluster that is the primary node of a replication group

• A node group (shard) that has Multi-AZ mode enabled

• A cluster from a Redis (cluster mode enabled) replication group

• A cluster that is not in the available state

Parameter Syntax

$result = $client->deleteCacheCluster([
    'CacheClusterId' => '<string>', // REQUIRED
    'FinalSnapshotIdentifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CacheCluster' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'AuthTokenLastModifiedDate' => <DateTime>,
        'AutoMinorVersionUpgrade' => true || false,
        'CacheClusterCreateTime' => <DateTime>,
        'CacheClusterId' => '<string>',
        'CacheClusterStatus' => '<string>',
        'CacheNodeType' => '<string>',
        'CacheNodes' => [
            [
                'CacheNodeCreateTime' => <DateTime>,
                'CacheNodeId' => '<string>',
                'CacheNodeStatus' => '<string>',
                'CustomerAvailabilityZone' => '<string>',
                'CustomerOutpostArn' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'ParameterGroupStatus' => '<string>',
                'SourceCacheNodeId' => '<string>',
            ],
            // ...
        ],
        'CacheParameterGroup' => [
            'CacheNodeIdsToReboot' => ['<string>', ...],
            'CacheParameterGroupName' => '<string>',
            'ParameterApplyStatus' => '<string>',
        ],
        'CacheSecurityGroups' => [
            [
                'CacheSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'CacheSubnetGroupName' => '<string>',
        'ClientDownloadLandingPage' => '<string>',
        'ConfigurationEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'IpDiscovery' => 'ipv4|ipv6',
        'LogDeliveryConfigurations' => [
            [
                'DestinationDetails' => [
                    'CloudWatchLogsDetails' => [
                        'LogGroup' => '<string>',
                    ],
                    'KinesisFirehoseDetails' => [
                        'DeliveryStream' => '<string>',
                    ],
                ],
                'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                'LogFormat' => 'text|json',
                'LogType' => 'slow-log|engine-log',
                'Message' => '<string>',
                'Status' => 'active|enabling|modifying|disabling|error',
            ],
            // ...
        ],
        'NetworkType' => 'ipv4|ipv6|dual_stack',
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'NumCacheNodes' => <integer>,
        'PendingModifiedValues' => [
            'AuthTokenStatus' => 'SETTING|ROTATING',
            'CacheNodeIdsToRemove' => ['<string>', ...],
            'CacheNodeType' => '<string>',
            'EngineVersion' => '<string>',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                ],
                // ...
            ],
            'NumCacheNodes' => <integer>,
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
        ],
        'PreferredAvailabilityZone' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PreferredOutpostArn' => '<string>',
        'ReplicationGroupId' => '<string>',
        'ReplicationGroupLogDeliveryEnabled' => true || false,
        'SecurityGroups' => [
            [
                'SecurityGroupId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'TransitEncryptionEnabled' => true || false,
        'TransitEncryptionMode' => 'preferred|required',
    ],
]

Result Details

Errors

CacheClusterNotFoundFault:

The requested cluster ID does not refer to an existing cluster.

InvalidCacheClusterStateFault:

The requested cluster is not in the available state.

SnapshotAlreadyExistsFault:

You already have a snapshot with the given name.

SnapshotFeatureNotSupportedFault:

You attempted one of the following operations:

• Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.

• Creating a snapshot of a cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

SnapshotQuotaExceededFault:

The request cannot be processed because it would exceed the maximum number of snapshots.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DeleteCacheCluster

Deletes an Amazon ElastiCache cluster.

$result = $client->deleteCacheCluster([
    'CacheClusterId' => 'my-memcached',
]);

Result syntax:

[
    'CacheCluster' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterCreateTime' => ,
        'CacheClusterId' => 'my-memcached',
        'CacheClusterStatus' => 'deleting',
        'CacheNodeType' => 'cache.r3.large',
        'CacheParameterGroup' => [
            'CacheNodeIdsToReboot' => [
            ],
            'CacheParameterGroupName' => 'default.memcached1.4',
            'ParameterApplyStatus' => 'in-sync',
        ],
        'CacheSecurityGroups' => [
        ],
        'CacheSubnetGroupName' => 'default',
        'ClientDownloadLandingPage' => 'https://console.aws.amazon.com/elasticache/home#client-download:',
        'ConfigurationEndpoint' => [
            'Address' => 'my-memcached2.ameaqx.cfg.use1.cache.amazonaws.com',
            'Port' => 11211,
        ],
        'Engine' => 'memcached',
        'EngineVersion' => '1.4.24',
        'NumCacheNodes' => 2,
        'PendingModifiedValues' => [
        ],
        'PreferredAvailabilityZone' => 'Multiple',
        'PreferredMaintenanceWindow' => 'tue:07:30-tue:08:30',
    ],
]

DeleteCacheParameterGroup

$result = $client->deleteCacheParameterGroup([/* ... */]);
$promise = $client->deleteCacheParameterGroupAsync([/* ... */]);

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.

Parameter Syntax

$result = $client->deleteCacheParameterGroup([
    'CacheParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidCacheParameterGroupStateFault:

The current state of the cache parameter group does not allow the requested operation to occur.

CacheParameterGroupNotFoundFault:

The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DeleteCacheParameterGroup

Deletes the Amazon ElastiCache parameter group custom-mem1-4.

$result = $client->deleteCacheParameterGroup([
    'CacheParameterGroupName' => 'custom-mem1-4',
]);

DeleteCacheSecurityGroup

$result = $client->deleteCacheSecurityGroup([/* ... */]);
$promise = $client->deleteCacheSecurityGroupAsync([/* ... */]);

Deletes a cache security group.

Parameter Syntax

$result = $client->deleteCacheSecurityGroup([
    'CacheSecurityGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidCacheSecurityGroupStateFault:

The current state of the cache security group does not allow deletion.

CacheSecurityGroupNotFoundFault:

The requested cache security group name does not refer to an existing cache security group.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DeleteCacheSecurityGroup

Deletes a cache security group.

$result = $client->deleteCacheSecurityGroup([
    'CacheSecurityGroupName' => 'my-sec-group',
]);

DeleteCacheSubnetGroup

$result = $client->deleteCacheSubnetGroup([/* ... */]);
$promise = $client->deleteCacheSubnetGroupAsync([/* ... */]);

Deletes a cache subnet group.

Parameter Syntax

$result = $client->deleteCacheSubnetGroup([
    'CacheSubnetGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

CacheSubnetGroupInUse:

The requested cache subnet group is currently in use.

CacheSubnetGroupNotFoundFault:

The requested cache subnet group name does not refer to an existing cache subnet group.

Examples

Example 1: DeleteCacheSubnetGroup

Deletes the Amazon ElastiCache subnet group my-subnet-group.

$result = $client->deleteCacheSubnetGroup([
    'CacheSubnetGroupName' => 'my-subnet-group',
]);

DeleteGlobalReplicationGroup

$result = $client->deleteGlobalReplicationGroup([/* ... */]);
$promise = $client->deleteGlobalReplicationGroupAsync([/* ... */]);

Deleting a Global datastore is a two-step process:

• First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

• Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Parameter Syntax

$result = $client->deleteGlobalReplicationGroup([
    'GlobalReplicationGroupId' => '<string>', // REQUIRED
    'RetainPrimaryReplicationGroup' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GlobalReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalNodeGroups' => [
            [
                'GlobalNodeGroupId' => '<string>',
                'Slots' => '<string>',
            ],
            // ...
        ],
        'GlobalReplicationGroupDescription' => '<string>',
        'GlobalReplicationGroupId' => '<string>',
        'Members' => [
            [
                'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
                'ReplicationGroupId' => '<string>',
                'ReplicationGroupRegion' => '<string>',
                'Role' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
    ],
]

Result Details

Errors

GlobalReplicationGroupNotFoundFault:

The Global datastore does not exist

InvalidGlobalReplicationGroupStateFault:

The Global datastore is not available or in primary-only state.

InvalidParameterValueException:

The value for a parameter is invalid.

DeleteReplicationGroup

$result = $client->deleteReplicationGroup([/* ... */]);
$promise = $client->deleteReplicationGroupAsync([/* ... */]);

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Parameter Syntax

$result = $client->deleteReplicationGroup([
    'FinalSnapshotIdentifier' => '<string>',
    'ReplicationGroupId' => '<string>', // REQUIRED
    'RetainPrimaryCluster' => true || false,
]);

Parameter Details

Result Syntax

[
    'ReplicationGroup' => [
        'ARN' => '<string>',
        'AtRestEncryptionEnabled' => true || false,
        'AuthTokenEnabled' => true || false,
        'AuthTokenLastModifiedDate' => <DateTime>,
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheNodeType' => '<string>',
        'ClusterEnabled' => true || false,
        'ClusterMode' => 'enabled|disabled|compatible',
        'ConfigurationEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'enabled|disabled',
        'Description' => '<string>',
        'GlobalReplicationGroupInfo' => [
            'GlobalReplicationGroupId' => '<string>',
            'GlobalReplicationGroupMemberRole' => '<string>',
        ],
        'IpDiscovery' => 'ipv4|ipv6',
        'KmsKeyId' => '<string>',
        'LogDeliveryConfigurations' => [
            [
                'DestinationDetails' => [
                    'CloudWatchLogsDetails' => [
                        'LogGroup' => '<string>',
                    ],
                    'KinesisFirehoseDetails' => [
                        'DeliveryStream' => '<string>',
                    ],
                ],
                'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                'LogFormat' => 'text|json',
                'LogType' => 'slow-log|engine-log',
                'Message' => '<string>',
                'Status' => 'active|enabling|modifying|disabling|error',
            ],
            // ...
        ],
        'MemberClusters' => ['<string>', ...],
        'MemberClustersOutpostArns' => ['<string>', ...],
        'MultiAZ' => 'enabled|disabled',
        'NetworkType' => 'ipv4|ipv6|dual_stack',
        'NodeGroups' => [
            [
                'NodeGroupId' => '<string>',
                'NodeGroupMembers' => [
                    [
                        'CacheClusterId' => '<string>',
                        'CacheNodeId' => '<string>',
                        'CurrentRole' => '<string>',
                        'PreferredAvailabilityZone' => '<string>',
                        'PreferredOutpostArn' => '<string>',
                        'ReadEndpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'PrimaryEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'ReaderEndpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                ],
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AuthTokenStatus' => 'SETTING|ROTATING',
            'AutomaticFailoverStatus' => 'enabled|disabled',
            'ClusterMode' => 'enabled|disabled|compatible',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                ],
                // ...
            ],
            'PrimaryClusterId' => '<string>',
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
            'UserGroups' => [
                'UserGroupIdsToAdd' => ['<string>', ...],
                'UserGroupIdsToRemove' => ['<string>', ...],
            ],
        ],
        'ReplicationGroupCreateTime' => <DateTime>,
        'ReplicationGroupId' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnapshottingClusterId' => '<string>',
        'Status' => '<string>',
        'TransitEncryptionEnabled' => true || false,
        'TransitEncryptionMode' => 'preferred|required',
        'UserGroupIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidReplicationGroupStateFault:

The requested replication group is not in the available state.

SnapshotAlreadyExistsFault:

You already have a snapshot with the given name.

SnapshotFeatureNotSupportedFault:

You attempted one of the following operations:

• Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.

• Creating a snapshot of a cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

SnapshotQuotaExceededFault:

The request cannot be processed because it would exceed the maximum number of snapshots.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DeleteReplicationGroup

Deletes the Amazon ElastiCache replication group my-redis-rg.

$result = $client->deleteReplicationGroup([
    'ReplicationGroupId' => 'my-redis-rg',
    'RetainPrimaryCluster' => ,
]);

Result syntax:

[
    'ReplicationGroup' => [
        'AutomaticFailover' => 'disabled',
        'Description' => 'simple redis cluster',
        'PendingModifiedValues' => [
        ],
        'ReplicationGroupId' => 'my-redis-rg',
        'Status' => 'deleting',
    ],
]

DeleteServerlessCache

$result = $client->deleteServerlessCache([/* ... */]);
$promise = $client->deleteServerlessCacheAsync([/* ... */]);

Deletes a specified existing serverless cache.

Parameter Syntax

$result = $client->deleteServerlessCache([
    'FinalSnapshotName' => '<string>',
    'ServerlessCacheName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServerlessCache' => [
        'ARN' => '<string>',
        'CacheUsageLimits' => [
            'DataStorage' => [
                'Maximum' => <integer>,
                'Minimum' => <integer>,
                'Unit' => 'GB',
            ],
            'ECPUPerSecond' => [
                'Maximum' => <integer>,
                'Minimum' => <integer>,
            ],
        ],
        'CreateTime' => <DateTime>,
        'DailySnapshotTime' => '<string>',
        'Description' => '<string>',
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'FullEngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MajorEngineVersion' => '<string>',
        'ReaderEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'SecurityGroupIds' => ['<string>', ...],
        'ServerlessCacheName' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'Status' => '<string>',
        'SubnetIds' => ['<string>', ...],
        'UserGroupId' => '<string>',
    ],
]

Result Details

Errors

ServerlessCacheNotFoundFault:

The serverless cache was not found or does not exist.

InvalidServerlessCacheStateFault:

The account for these credentials is not currently active.

ServerlessCacheSnapshotAlreadyExistsFault:

A serverless cache snapshot with this name already exists. Available for Redis only.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

InvalidCredentialsException:

You must enter valid credentials.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

DeleteServerlessCacheSnapshot

$result = $client->deleteServerlessCacheSnapshot([/* ... */]);
$promise = $client->deleteServerlessCacheSnapshotAsync([/* ... */]);

Deletes an existing serverless cache snapshot. Available for Redis only.

Parameter Syntax

$result = $client->deleteServerlessCacheSnapshot([
    'ServerlessCacheSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServerlessCacheSnapshot' => [
        'ARN' => '<string>',
        'BytesUsedForCache' => '<string>',
        'CreateTime' => <DateTime>,
        'ExpiryTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'ServerlessCacheConfiguration' => [
            'Engine' => '<string>',
            'MajorEngineVersion' => '<string>',
            'ServerlessCacheName' => '<string>',
        ],
        'ServerlessCacheSnapshotName' => '<string>',
        'SnapshotType' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

ServerlessCacheSnapshotNotFoundFault:

This serverless cache snapshot could not be found or does not exist. Available for Redis only.

InvalidServerlessCacheSnapshotStateFault:

The state of the serverless cache snapshot was not received. Available for Redis only.

InvalidParameterValueException:

The value for a parameter is invalid.

DeleteSnapshot

$result = $client->deleteSnapshot([/* ... */]);
$promise = $client->deleteSnapshotAsync([/* ... */]);

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

Parameter Syntax

$result = $client->deleteSnapshot([
    'SnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Snapshot' => [
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
        'CacheClusterCreateTime' => <DateTime>,
        'CacheClusterId' => '<string>',
        'CacheNodeType' => '<string>',
        'CacheParameterGroupName' => '<string>',
        'CacheSubnetGroupName' => '<string>',
        'DataTiering' => 'enabled|disabled',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'NodeSnapshots' => [
            [
                'CacheClusterId' => '<string>',
                'CacheNodeCreateTime' => <DateTime>,
                'CacheNodeId' => '<string>',
                'CacheSize' => '<string>',
                'NodeGroupConfiguration' => [
                    'NodeGroupId' => '<string>',
                    'PrimaryAvailabilityZone' => '<string>',
                    'PrimaryOutpostArn' => '<string>',
                    'ReplicaAvailabilityZones' => ['<string>', ...],
                    'ReplicaCount' => <integer>,
                    'ReplicaOutpostArns' => ['<string>', ...],
                    'Slots' => '<string>',
                ],
                'NodeGroupId' => '<string>',
                'SnapshotCreateTime' => <DateTime>,
            ],
            // ...
        ],
        'NumCacheNodes' => <integer>,
        'NumNodeGroups' => <integer>,
        'Port' => <integer>,
        'PreferredAvailabilityZone' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PreferredOutpostArn' => '<string>',
        'ReplicationGroupDescription' => '<string>',
        'ReplicationGroupId' => '<string>',
        'SnapshotName' => '<string>',
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotSource' => '<string>',
        'SnapshotStatus' => '<string>',
        'SnapshotWindow' => '<string>',
        'TopicArn' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

SnapshotNotFoundFault:

The requested snapshot name does not refer to an existing snapshot.

InvalidSnapshotStateFault:

The current state of the snapshot does not allow the requested operation to occur.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DeleteSnapshot

Deletes the Redis snapshot snapshot-20160822.

$result = $client->deleteSnapshot([
    'SnapshotName' => 'snapshot-20161212',
]);

Result syntax:

[
    'Snapshot' => [
        'AutoMinorVersionUpgrade' => 1,
        'CacheClusterCreateTime' => ,
        'CacheClusterId' => 'my-redis5',
        'CacheNodeType' => 'cache.m3.large',
        'CacheParameterGroupName' => 'default.redis3.2',
        'CacheSubnetGroupName' => 'default',
        'Engine' => 'redis',
        'EngineVersion' => '3.2.4',
        'NodeSnapshots' => [
            [
                'CacheNodeCreateTime' => ,
                'CacheNodeId' => '0001',
                'CacheSize' => '3 MB',
                'SnapshotCreateTime' => ,
            ],
        ],
        'NumCacheNodes' => 1,
        'Port' => 6379,
        'PreferredAvailabilityZone' => 'us-east-1c',
        'PreferredMaintenanceWindow' => 'fri:05:30-fri:06:30',
        'SnapshotName' => 'snapshot-20161212',
        'SnapshotRetentionLimit' => 7,
        'SnapshotSource' => 'manual',
        'SnapshotStatus' => 'deleting',
        'SnapshotWindow' => '10:00-11:00',
        'VpcId' => 'vpc-91280df6',
    ],
]

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

Parameter Syntax

$result = $client->deleteUser([
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ARN' => '<string>',
    'AccessString' => '<string>',
    'Authentication' => [
        'PasswordCount' => <integer>,
        'Type' => 'password|no-password|iam',
    ],
    'Engine' => '<string>',
    'MinimumEngineVersion' => '<string>',
    'Status' => '<string>',
    'UserGroupIds' => ['<string>', ...],
    'UserId' => '<string>',
    'UserName' => '<string>',
]

Result Details

Errors

InvalidUserStateFault:

The user is not in active state.

UserNotFoundFault:

The user does not exist or could not be found.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

InvalidParameterValueException:

The value for a parameter is invalid.

DefaultUserAssociatedToUserGroupFault:

The default user assigned to the user group.

DeleteUserGroup

$result = $client->deleteUserGroup([/* ... */]);
$promise = $client->deleteUserGroupAsync([/* ... */]);

For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

Parameter Syntax

$result = $client->deleteUserGroup([
    'UserGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ARN' => '<string>',
    'Engine' => '<string>',
    'MinimumEngineVersion' => '<string>',
    'PendingChanges' => [
        'UserIdsToAdd' => ['<string>', ...],
        'UserIdsToRemove' => ['<string>', ...],
    ],
    'ReplicationGroups' => ['<string>', ...],
    'ServerlessCaches' => ['<string>', ...],
    'Status' => '<string>',
    'UserGroupId' => '<string>',
    'UserIds' => ['<string>', ...],
]

Result Details

Errors

UserGroupNotFoundFault:

The user group was not found or does not exist

InvalidUserGroupStateFault:

The user group is not in an active state.

ServiceLinkedRoleNotFoundFault:

The specified service linked role (SLR) was not found.

InvalidParameterValueException:

The value for a parameter is invalid.

DescribeCacheClusters

$result = $client->describeCacheClusters([/* ... */]);
$promise = $client->describeCacheClustersAsync([/* ... */]);

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

Parameter Syntax

$result = $client->describeCacheClusters([
    'CacheClusterId' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ShowCacheClustersNotInReplicationGroups' => true || false,
    'ShowCacheNodeInfo' => true || false,
]);

Parameter Details

Result Syntax

[
    'CacheClusters' => [
        [
            'ARN' => '<string>',
            'AtRestEncryptionEnabled' => true || false,
            'AuthTokenEnabled' => true || false,
            'AuthTokenLastModifiedDate' => <DateTime>,
            'AutoMinorVersionUpgrade' => true || false,
            'CacheClusterCreateTime' => <DateTime>,
            'CacheClusterId' => '<string>',
            'CacheClusterStatus' => '<string>',
            'CacheNodeType' => '<string>',
            'CacheNodes' => [
                [
                    'CacheNodeCreateTime' => <DateTime>,
                    'CacheNodeId' => '<string>',
                    'CacheNodeStatus' => '<string>',
                    'CustomerAvailabilityZone' => '<string>',
                    'CustomerOutpostArn' => '<string>',
                    'Endpoint' => [
                        'Address' => '<string>',
                        'Port' => <integer>,
                    ],
                    'ParameterGroupStatus' => '<string>',
                    'SourceCacheNodeId' => '<string>',
                ],
                // ...
            ],
            'CacheParameterGroup' => [
                'CacheNodeIdsToReboot' => ['<string>', ...],
                'CacheParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            'CacheSecurityGroups' => [
                [
                    'CacheSecurityGroupName' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'CacheSubnetGroupName' => '<string>',
            'ClientDownloadLandingPage' => '<string>',
            'ConfigurationEndpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
            ],
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'IpDiscovery' => 'ipv4|ipv6',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                    'Message' => '<string>',
                    'Status' => 'active|enabling|modifying|disabling|error',
                ],
                // ...
            ],
            'NetworkType' => 'ipv4|ipv6|dual_stack',
            'NotificationConfiguration' => [
                'TopicArn' => '<string>',
                'TopicStatus' => '<string>',
            ],
            'NumCacheNodes' => <integer>,
            'PendingModifiedValues' => [
                'AuthTokenStatus' => 'SETTING|ROTATING',
                'CacheNodeIdsToRemove' => ['<string>', ...],
                'CacheNodeType' => '<string>',
                'EngineVersion' => '<string>',
                'LogDeliveryConfigurations' => [
                    [
                        'DestinationDetails' => [
                            'CloudWatchLogsDetails' => [
                                'LogGroup' => '<string>',
                            ],
                            'KinesisFirehoseDetails' => [
                                'DeliveryStream' => '<string>',
                            ],
                        ],
                        'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                        'LogFormat' => 'text|json',
                        'LogType' => 'slow-log|engine-log',
                    ],
                    // ...
                ],
                'NumCacheNodes' => <integer>,
                'TransitEncryptionEnabled' => true || false,
                'TransitEncryptionMode' => 'preferred|required',
            ],
            'PreferredAvailabilityZone' => '<string>',
            'PreferredMaintenanceWindow' => '<string>',
            'PreferredOutpostArn' => '<string>',
            'ReplicationGroupId' => '<string>',
            'ReplicationGroupLogDeliveryEnabled' => true || false,
            'SecurityGroups' => [
                [
                    'SecurityGroupId' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

CacheClusterNotFoundFault:

The requested cluster ID does not refer to an existing cluster.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeCacheClusters

Lists the details for up to 50 cache clusters.

$result = $client->describeCacheClusters([
    'CacheClusterId' => 'my-mem-cluster',
]);

Result syntax:

[
    'CacheClusters' => [
        [
            'AutoMinorVersionUpgrade' => 1,
            'CacheClusterCreateTime' => ,
            'CacheClusterId' => 'my-mem-cluster',
            'CacheClusterStatus' => 'available',
            'CacheNodeType' => 'cache.t2.medium',
            'CacheParameterGroup' => [
                'CacheNodeIdsToReboot' => [
                ],
                'CacheParameterGroupName' => 'default.memcached1.4',
                'ParameterApplyStatus' => 'in-sync',
            ],
            'CacheSecurityGroups' => [
            ],
            'CacheSubnetGroupName' => 'default',
            'ClientDownloadLandingPage' => 'https://console.aws.amazon.com/elasticache/home#client-download:',
            'ConfigurationEndpoint' => [
                'Address' => 'my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com',
                'Port' => 11211,
            ],
            'Engine' => 'memcached',
            'EngineVersion' => '1.4.24',
            'NumCacheNodes' => 2,
            'PendingModifiedValues' => [
            ],
            'PreferredAvailabilityZone' => 'Multiple',
            'PreferredMaintenanceWindow' => 'wed:06:00-wed:07:00',
        ],
    ],
]

Example 2: DescribeCacheClusters

Lists the details for the cache cluster my-mem-cluster.

$result = $client->describeCacheClusters([
    'CacheClusterId' => 'my-mem-cluster',
    'ShowCacheNodeInfo' => 1,
]);

Result syntax:

[
    'CacheClusters' => [
        [
            'AutoMinorVersionUpgrade' => 1,
            'CacheClusterCreateTime' => ,
            'CacheClusterId' => 'my-mem-cluster',
            'CacheClusterStatus' => 'available',
            'CacheNodeType' => 'cache.t2.medium',
            'CacheNodes' => [
                [
                    'CacheNodeCreateTime' => ,
                    'CacheNodeId' => '0001',
                    'CacheNodeStatus' => 'available',
                    'CustomerAvailabilityZone' => 'us-east-1b',
                    'Endpoint' => [
                        'Address' => 'my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com',
                        'Port' => 11211,
                    ],
                    'ParameterGroupStatus' => 'in-sync',
                ],
                [
                    'CacheNodeCreateTime' => ,
                    'CacheNodeId' => '0002',
                    'CacheNodeStatus' => 'available',
                    'CustomerAvailabilityZone' => 'us-east-1a',
                    'Endpoint' => [
                        'Address' => 'my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com',
                        'Port' => 11211,
                    ],
                    'ParameterGroupStatus' => 'in-sync',
                ],
            ],
            'CacheParameterGroup' => [
                'CacheNodeIdsToReboot' => [
                ],
                'CacheParameterGroupName' => 'default.memcached1.4',
                'ParameterApplyStatus' => 'in-sync',
            ],
            'CacheSecurityGroups' => [
            ],
            'CacheSubnetGroupName' => 'default',
            'ClientDownloadLandingPage' => 'https://console.aws.amazon.com/elasticache/home#client-download:',
            'ConfigurationEndpoint' => [
                'Address' => 'my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com',
                'Port' => 11211,
            ],
            'Engine' => 'memcached',
            'EngineVersion' => '1.4.24',
            'NumCacheNodes' => 2,
            'PendingModifiedValues' => [
            ],
            'PreferredAvailabilityZone' => 'Multiple',
            'PreferredMaintenanceWindow' => 'wed:06:00-wed:07:00',
        ],
    ],
]

DescribeCacheEngineVersions

$result = $client->describeCacheEngineVersions([/* ... */]);
$promise = $client->describeCacheEngineVersionsAsync([/* ... */]);

Returns a list of the available cache engines and their versions.

Parameter Syntax

$result = $client->describeCacheEngineVersions([
    'CacheParameterGroupFamily' => '<string>',
    'DefaultOnly' => true || false,
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'CacheEngineVersions' => [
        [
            'CacheEngineDescription' => '<string>',
            'CacheEngineVersionDescription' => '<string>',
            'CacheParameterGroupFamily' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: DescribeCacheEngineVersions

Lists the details for up to 25 Memcached and Redis cache engine versions.

$result = $client->describeCacheEngineVersions([
]);

Result syntax:

[
    'CacheEngineVersions' => [
        [
            'CacheEngineDescription' => 'memcached',
            'CacheEngineVersionDescription' => 'memcached version 1.4.14',
            'CacheParameterGroupFamily' => 'memcached1.4',
            'Engine' => 'memcached',
            'EngineVersion' => '1.4.14',
        ],
        [
            'CacheEngineDescription' => 'memcached',
            'CacheEngineVersionDescription' => 'memcached version 1.4.24',
            'CacheParameterGroupFamily' => 'memcached1.4',
            'Engine' => 'memcached',
            'EngineVersion' => '1.4.24',
        ],
        [
            'CacheEngineDescription' => 'memcached',
            'CacheEngineVersionDescription' => 'memcached version 1.4.33',
            'CacheParameterGroupFamily' => 'memcached1.4',
            'Engine' => 'memcached',
            'EngineVersion' => '1.4.33',
        ],
        [
            'CacheEngineDescription' => 'memcached',
            'CacheEngineVersionDescription' => 'memcached version 1.4.5',
            'CacheParameterGroupFamily' => 'memcached1.4',
            'Engine' => 'memcached',
            'EngineVersion' => '1.4.5',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.6.13',
            'CacheParameterGroupFamily' => 'redis2.6',
            'Engine' => 'redis',
            'EngineVersion' => '2.6.13',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.19',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.19',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.21',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.21',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.22 R5',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.22',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.23 R4',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.23',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.24 R3',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.24',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.6',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.6',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 3.2.4',
            'CacheParameterGroupFamily' => 'redis3.2',
            'Engine' => 'redis',
            'EngineVersion' => '3.2.4',
        ],
    ],
]

Example 2: DescribeCacheEngineVersions

Lists the details for up to 50 Redis cache engine versions.

$result = $client->describeCacheEngineVersions([
    'DefaultOnly' => ,
    'Engine' => 'redis',
    'MaxRecords' => 50,
]);

Result syntax:

[
    'CacheEngineVersions' => [
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.6.13',
            'CacheParameterGroupFamily' => 'redis2.6',
            'Engine' => 'redis',
            'EngineVersion' => '2.6.13',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.19',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.19',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.21',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.21',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.22 R5',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.22',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.23 R4',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.23',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.24 R3',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.24',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 2.8.6',
            'CacheParameterGroupFamily' => 'redis2.8',
            'Engine' => 'redis',
            'EngineVersion' => '2.8.6',
        ],
        [
            'CacheEngineDescription' => 'Redis',
            'CacheEngineVersionDescription' => 'redis version 3.2.4',
            'CacheParameterGroupFamily' => 'redis3.2',
            'Engine' => 'redis',
            'EngineVersion' => '3.2.4',
        ],
    ],
    'Marker' => '',
]

DescribeCacheParameterGroups

$result = $client->describeCacheParameterGroups([/* ... */]);
$promise = $client->describeCacheParameterGroupsAsync([/* ... */]);

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

Parameter Syntax

$result = $client->describeCacheParameterGroups([
    'CacheParameterGroupName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'CacheParameterGroups' => [
        [
            'ARN' => '<string>',
            'CacheParameterGroupFamily' => '<string>',
            'CacheParameterGroupName' => '<string>',
            'Description' => '<string>',
            'IsGlobal' => true || false,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

CacheParameterGroupNotFoundFault:

The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeCacheParameterGroups

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

$result = $client->describeCacheParameterGroups([
    'CacheParameterGroupName' => 'custom-mem1-4',
]);

Result syntax:

[
    'CacheParameterGroups' => [
        [
            'CacheParameterGroupFamily' => 'memcached1.4',
            'CacheParameterGroupName' => 'custom-mem1-4',
            'Description' => 'Custom memcache param group',
        ],
    ],
]

DescribeCacheParameters

$result = $client->describeCacheParameters([/* ... */]);
$promise = $client->describeCacheParametersAsync([/* ... */]);

Returns the detailed parameter list for a particular cache parameter group.

Parameter Syntax

$result = $client->describeCacheParameters([
    'CacheParameterGroupName' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'Source' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CacheNodeTypeSpecificParameters' => [
        [
            'AllowedValues' => '<string>',
            'CacheNodeTypeSpecificValues' => [
                [
                    'CacheNodeType' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ChangeType' => 'immediate|requires-reboot',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ChangeType' => 'immediate|requires-reboot',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

CacheParameterGroupNotFoundFault:

The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeCacheParameters

Lists up to 100 user parameter values for the parameter group custom.redis2.8.

$result = $client->describeCacheParameters([
    'CacheParameterGroupName' => 'custom-redis2-8',
    'MaxRecords' => 100,
    'Source' => 'user',
]);

Result syntax:

[
    'Marker' => '',
    'Parameters' => [
        [
            'AllowedValues' => 'yes,no',
            'ChangeType' => 'requires-reboot',
            'DataType' => 'string',
            'Description' => 'Apply rehashing or not.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'activerehashing',
            'ParameterValue' => 'yes',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => 'always,everysec,no',
            'ChangeType' => 'immediate',
            'DataType' => 'string',
            'Description' => 'fsync policy for AOF persistence',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'appendfsync',
            'ParameterValue' => 'everysec',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => 'yes,no',
            'ChangeType' => 'immediate',
            'DataType' => 'string',
            'Description' => 'Enable Redis persistence.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'appendonly',
            'ParameterValue' => 'no',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Normal client output buffer hard limit in bytes.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-normal-hard-limit',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Normal client output buffer soft limit in bytes.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-normal-soft-limit',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Normal client output buffer soft limit in seconds.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-normal-soft-seconds',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Pubsub client output buffer hard limit in bytes.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-pubsub-hard-limit',
            'ParameterValue' => '33554432',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Pubsub client output buffer soft limit in bytes.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-pubsub-soft-limit',
            'ParameterValue' => '8388608',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Pubsub client output buffer soft limit in seconds.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-pubsub-soft-seconds',
            'ParameterValue' => '60',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Slave client output buffer soft limit in seconds.',
            'IsModifiable' => ,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'client-output-buffer-limit-slave-soft-seconds',
            'ParameterValue' => '60',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => 'yes,no',
            'ChangeType' => 'immediate',
            'DataType' => 'string',
            'Description' => 'If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.23',
            'ParameterName' => 'close-on-slave-write',
            'ParameterValue' => 'yes',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '1-1200000',
            'ChangeType' => 'requires-reboot',
            'DataType' => 'integer',
            'Description' => 'Set the number of databases.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'databases',
            'ParameterValue' => '16',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The maximum number of hash entries in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'hash-max-ziplist-entries',
            'ParameterValue' => '512',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The threshold of biggest hash entries in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'hash-max-ziplist-value',
            'ParameterValue' => '64',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The maximum number of list entries in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'list-max-ziplist-entries',
            'ParameterValue' => '512',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The threshold of biggest list entries in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'list-max-ziplist-value',
            'ParameterValue' => '64',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '5000',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.',
            'IsModifiable' => ,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'lua-time-limit',
            'ParameterValue' => '5000',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '1-65000',
            'ChangeType' => 'requires-reboot',
            'DataType' => 'integer',
            'Description' => 'The maximum number of Redis clients.',
            'IsModifiable' => ,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'maxclients',
            'ParameterValue' => '65000',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => 'volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction',
            'ChangeType' => 'immediate',
            'DataType' => 'string',
            'Description' => 'Max memory policy.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'maxmemory-policy',
            'ParameterValue' => 'volatile-lru',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '1-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Max memory samples.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'maxmemory-samples',
            'ParameterValue' => '3',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'min-slaves-max-lag',
            'ParameterValue' => '10',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'min-slaves-to-write',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'ChangeType' => 'immediate',
            'DataType' => 'string',
            'Description' => 'The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'notify-keyspace-events',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '16384-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'repl-backlog-size',
            'ParameterValue' => '1048576',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'repl-backlog-ttl',
            'ParameterValue' => '3600',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '11-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The timeout in seconds for bulk transfer I/O during sync and master timeout from the perspective of the slave, and slave timeout from the perspective of the master.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'repl-timeout',
            'ParameterValue' => '60',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The amount of memory reserved for non-cache memory usage, in bytes. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'reserved-memory',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The limit in the size of the set in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'set-max-intset-entries',
            'ParameterValue' => '512',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => 'yes,no',
            'ChangeType' => 'immediate',
            'DataType' => 'string',
            'Description' => 'Configures if chaining of slaves is allowed',
            'IsModifiable' => ,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'slave-allow-chaining',
            'ParameterValue' => 'no',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'slowlog-log-slower-than',
            'ParameterValue' => '10000',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'slowlog-max-len',
            'ParameterValue' => '128',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'If non-zero, send ACKs every given number of seconds.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'tcp-keepalive',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0,20-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'Close connection if client is idle for a given number of seconds, or never if 0.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'timeout',
            'ParameterValue' => '0',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The maximum number of sorted set entries in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'zset-max-ziplist-entries',
            'ParameterValue' => '128',
            'Source' => 'system',
        ],
        [
            'AllowedValues' => '0-',
            'ChangeType' => 'immediate',
            'DataType' => 'integer',
            'Description' => 'The threshold of biggest sorted set entries in order for the dataset to be compressed.',
            'IsModifiable' => 1,
            'MinimumEngineVersion' => '2.8.6',
            'ParameterName' => 'zset-max-ziplist-value',
            'ParameterValue' => '64',
            'Source' => 'system',
        ],
    ],
]

DescribeCacheSecurityGroups

$result = $client->describeCacheSecurityGroups([/* ... */]);
$promise = $client->describeCacheSecurityGroupsAsync([/* ... */]);

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

Parameter Syntax

$result = $client->describeCacheSecurityGroups([
    'CacheSecurityGroupName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'CacheSecurityGroups' => [
        [
            'ARN' => '<string>',
            'CacheSecurityGroupName' => '<string>',
            'Description' => '<string>',
            'EC2SecurityGroups' => [
                [
                    'EC2SecurityGroupName' => '<string>',
                    'EC2SecurityGroupOwnerId' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'OwnerId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

CacheSecurityGroupNotFoundFault:

The requested cache security group name does not refer to an existing cache security group.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeCacheSecurityGroups

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.

$result = $client->describeCacheSecurityGroups([
    'CacheSecurityGroupName' => 'my-sec-group',
]);

DescribeCacheSubnetGroups

$result = $client->describeCacheSubnetGroups([/* ... */]);
$promise = $client->describeCacheSubnetGroupsAsync([/* ... */]);

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

Parameter Syntax

$result = $client->describeCacheSubnetGroups([
    'CacheSubnetGroupName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'CacheSubnetGroups' => [
        [
            'ARN' => '<string>',
            'CacheSubnetGroupDescription' => '<string>',
            'CacheSubnetGroupName' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetOutpost' => [
                        'SubnetOutpostArn' => '<string>',
                    ],
                    'SupportedNetworkTypes' => ['<string>', ...],
                ],
                // ...
            ],
            'SupportedNetworkTypes' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

CacheSubnetGroupNotFoundFault:

The requested cache subnet group name does not refer to an existing cache subnet group.

Examples

Example 1: DescribeCacheSubnetGroups

Describes up to 25 cache subnet groups.

$result = $client->describeCacheSubnetGroups([
    'MaxRecords' => 25,
]);

Result syntax:

[
    'CacheSubnetGroups' => [
        [
            'CacheSubnetGroupDescription' => 'Default CacheSubnetGroup',
            'CacheSubnetGroupName' => 'default',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1a',
                    ],
                    'SubnetIdentifier' => 'subnet-1a2b3c4d',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1c',
                    ],
                    'SubnetIdentifier' => 'subnet-a1b2c3d4',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1e',
                    ],
                    'SubnetIdentifier' => 'subnet-abcd1234',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1b',
                    ],
                    'SubnetIdentifier' => 'subnet-1234abcd',
                ],
            ],
            'VpcId' => 'vpc-91280df6',
        ],
    ],
    'Marker' => '',
]

DescribeEngineDefaultParameters

$result = $client->describeEngineDefaultParameters([/* ... */]);
$promise = $client->describeEngineDefaultParametersAsync([/* ... */]);

Returns the default engine and system parameter information for the specified cache engine.

Parameter Syntax

$result = $client->describeEngineDefaultParameters([
    'CacheParameterGroupFamily' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'EngineDefaults' => [
        'CacheNodeTypeSpecificParameters' => [
            [
                'AllowedValues' => '<string>',
                'CacheNodeTypeSpecificValues' => [
                    [
                        'CacheNodeType' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ChangeType' => 'immediate|requires-reboot',
                'DataType' => '<string>',
                'Description' => '<string>',
                'IsModifiable' => true || false,
                'MinimumEngineVersion' => '<string>',
                'ParameterName' => '<string>',
                'Source' => '<string>',
            ],
            // ...
        ],
        'CacheParameterGroupFamily' => '<string>',
        'Marker' => '<string>',
        'Parameters' => [
            [
                'AllowedValues' => '<string>',
                'ChangeType' => 'immediate|requires-reboot',
                'DataType' => '<string>',
                'Description' => '<string>',
                'IsModifiable' => true || false,
                'MinimumEngineVersion' => '<string>',
                'ParameterName' => '<string>',
                'ParameterValue' => '<string>',
                'Source' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeEngineDefaultParameters

Returns the default engine and system parameter information for the specified cache engine.

$result = $client->describeEngineDefaultParameters([
    'CacheParameterGroupFamily' => 'redis2.8',
    'MaxRecords' => 25,
]);

Result syntax:

[
    'EngineDefaults' => [
        'CacheNodeTypeSpecificParameters' => [
            [
                'AllowedValues' => '0-',
                'CacheNodeTypeSpecificValues' => [
                    [
                        'CacheNodeType' => 'cache.c1.xlarge',
                        'Value' => '650117120',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.large',
                        'Value' => '702545920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.medium',
                        'Value' => '309329920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.small',
                        'Value' => '94371840',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.xlarge',
                        'Value' => '1488977920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.2xlarge',
                        'Value' => '3502243840',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.4xlarge',
                        'Value' => '7088373760',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.xlarge',
                        'Value' => '1709178880',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.2xlarge',
                        'Value' => '2998927360',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.large',
                        'Value' => '650117120',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.medium',
                        'Value' => '309329920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.xlarge',
                        'Value' => '1426063360',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.10xlarge',
                        'Value' => '16604761424',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.2xlarge',
                        'Value' => '3188912636',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.4xlarge',
                        'Value' => '6525729063',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.large',
                        'Value' => '689259315',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.xlarge',
                        'Value' => '1532850176',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.2xlarge',
                        'Value' => '6081740800',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.4xlarge',
                        'Value' => '12268339200',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.8xlarge',
                        'Value' => '24536678400',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.large',
                        'Value' => '1468006400',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.xlarge',
                        'Value' => '3040870400',
                    ],
                    [
                        'CacheNodeType' => 'cache.t1.micro',
                        'Value' => '14260633',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.medium',
                        'Value' => '346134937',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.micro',
                        'Value' => '58195968',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.small',
                        'Value' => '166513868',
                    ],
                ],
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Slave client output buffer hard limit in bytes.',
                'IsModifiable' => ,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-slave-hard-limit',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'CacheNodeTypeSpecificValues' => [
                    [
                        'CacheNodeType' => 'cache.c1.xlarge',
                        'Value' => '650117120',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.large',
                        'Value' => '702545920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.medium',
                        'Value' => '309329920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.small',
                        'Value' => '94371840',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.xlarge',
                        'Value' => '1488977920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.2xlarge',
                        'Value' => '3502243840',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.4xlarge',
                        'Value' => '7088373760',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.xlarge',
                        'Value' => '1709178880',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.2xlarge',
                        'Value' => '2998927360',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.large',
                        'Value' => '650117120',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.medium',
                        'Value' => '309329920',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.xlarge',
                        'Value' => '1426063360',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.10xlarge',
                        'Value' => '16604761424',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.2xlarge',
                        'Value' => '3188912636',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.4xlarge',
                        'Value' => '6525729063',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.large',
                        'Value' => '689259315',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.xlarge',
                        'Value' => '1532850176',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.2xlarge',
                        'Value' => '6081740800',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.4xlarge',
                        'Value' => '12268339200',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.8xlarge',
                        'Value' => '24536678400',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.large',
                        'Value' => '1468006400',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.xlarge',
                        'Value' => '3040870400',
                    ],
                    [
                        'CacheNodeType' => 'cache.t1.micro',
                        'Value' => '14260633',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.medium',
                        'Value' => '346134937',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.micro',
                        'Value' => '58195968',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.small',
                        'Value' => '166513868',
                    ],
                ],
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Slave client output buffer soft limit in bytes.',
                'IsModifiable' => ,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-slave-soft-limit',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'CacheNodeTypeSpecificValues' => [
                    [
                        'CacheNodeType' => 'cache.c1.xlarge',
                        'Value' => '6501171200',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.large',
                        'Value' => '7025459200',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.medium',
                        'Value' => '3093299200',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.small',
                        'Value' => '943718400',
                    ],
                    [
                        'CacheNodeType' => 'cache.m1.xlarge',
                        'Value' => '14889779200',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.2xlarge',
                        'Value' => '35022438400',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.4xlarge',
                        'Value' => '70883737600',
                    ],
                    [
                        'CacheNodeType' => 'cache.m2.xlarge',
                        'Value' => '17091788800',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.2xlarge',
                        'Value' => '29989273600',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.large',
                        'Value' => '6501171200',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.medium',
                        'Value' => '2988441600',
                    ],
                    [
                        'CacheNodeType' => 'cache.m3.xlarge',
                        'Value' => '14260633600',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.10xlarge',
                        'Value' => '166047614239',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.2xlarge',
                        'Value' => '31889126359',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.4xlarge',
                        'Value' => '65257290629',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.large',
                        'Value' => '6892593152',
                    ],
                    [
                        'CacheNodeType' => 'cache.m4.xlarge',
                        'Value' => '15328501760',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.2xlarge',
                        'Value' => '62495129600',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.4xlarge',
                        'Value' => '126458265600',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.8xlarge',
                        'Value' => '254384537600',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.large',
                        'Value' => '14470348800',
                    ],
                    [
                        'CacheNodeType' => 'cache.r3.xlarge',
                        'Value' => '30513561600',
                    ],
                    [
                        'CacheNodeType' => 'cache.t1.micro',
                        'Value' => '142606336',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.medium',
                        'Value' => '3461349376',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.micro',
                        'Value' => '581959680',
                    ],
                    [
                        'CacheNodeType' => 'cache.t2.small',
                        'Value' => '1665138688',
                    ],
                ],
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'The maximum configurable amount of memory to use to store items, in bytes.',
                'IsModifiable' => ,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'maxmemory',
                'Source' => 'system',
            ],
        ],
        'CacheParameterGroupFamily' => 'redis2.8',
        'Marker' => 'bWluLXNsYXZlcy10by13cml0ZQ==',
        'Parameters' => [
            [
                'AllowedValues' => 'yes,no',
                'ChangeType' => 'requires-reboot',
                'DataType' => 'string',
                'Description' => 'Apply rehashing or not.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'activerehashing',
                'ParameterValue' => 'yes',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => 'always,everysec,no',
                'ChangeType' => 'immediate',
                'DataType' => 'string',
                'Description' => 'fsync policy for AOF persistence',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'appendfsync',
                'ParameterValue' => 'everysec',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => 'yes,no',
                'ChangeType' => 'immediate',
                'DataType' => 'string',
                'Description' => 'Enable Redis persistence.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'appendonly',
                'ParameterValue' => 'no',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Normal client output buffer hard limit in bytes.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-normal-hard-limit',
                'ParameterValue' => '0',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Normal client output buffer soft limit in bytes.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-normal-soft-limit',
                'ParameterValue' => '0',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Normal client output buffer soft limit in seconds.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-normal-soft-seconds',
                'ParameterValue' => '0',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Pubsub client output buffer hard limit in bytes.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-pubsub-hard-limit',
                'ParameterValue' => '33554432',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Pubsub client output buffer soft limit in bytes.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-pubsub-soft-limit',
                'ParameterValue' => '8388608',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Pubsub client output buffer soft limit in seconds.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-pubsub-soft-seconds',
                'ParameterValue' => '60',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Slave client output buffer soft limit in seconds.',
                'IsModifiable' => ,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'client-output-buffer-limit-slave-soft-seconds',
                'ParameterValue' => '60',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => 'yes,no',
                'ChangeType' => 'immediate',
                'DataType' => 'string',
                'Description' => 'If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.23',
                'ParameterName' => 'close-on-slave-write',
                'ParameterValue' => 'yes',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '1-1200000',
                'ChangeType' => 'requires-reboot',
                'DataType' => 'integer',
                'Description' => 'Set the number of databases.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'databases',
                'ParameterValue' => '16',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'The maximum number of hash entries in order for the dataset to be compressed.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'hash-max-ziplist-entries',
                'ParameterValue' => '512',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'The threshold of biggest hash entries in order for the dataset to be compressed.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'hash-max-ziplist-value',
                'ParameterValue' => '64',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'The maximum number of list entries in order for the dataset to be compressed.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'list-max-ziplist-entries',
                'ParameterValue' => '512',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'The threshold of biggest list entries in order for the dataset to be compressed.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'list-max-ziplist-value',
                'ParameterValue' => '64',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '5000',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.',
                'IsModifiable' => ,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'lua-time-limit',
                'ParameterValue' => '5000',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '1-65000',
                'ChangeType' => 'requires-reboot',
                'DataType' => 'integer',
                'Description' => 'The maximum number of Redis clients.',
                'IsModifiable' => ,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'maxclients',
                'ParameterValue' => '65000',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => 'volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction',
                'ChangeType' => 'immediate',
                'DataType' => 'string',
                'Description' => 'Max memory policy.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'maxmemory-policy',
                'ParameterValue' => 'volatile-lru',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '1-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Max memory samples.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'maxmemory-samples',
                'ParameterValue' => '3',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'min-slaves-max-lag',
                'ParameterValue' => '10',
                'Source' => 'system',
            ],
            [
                'AllowedValues' => '0-',
                'ChangeType' => 'immediate',
                'DataType' => 'integer',
                'Description' => 'Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.',
                'IsModifiable' => 1,
                'MinimumEngineVersion' => '2.8.6',
                'ParameterName' => 'min-slaves-to-write',
                'ParameterValue' => '0',
                'Source' => 'system',
            ],
        ],
    ],
]

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SourceIdentifier' => '<string>',
    'SourceType' => 'cache-cluster|cache-parameter-group|cache-security-group|cache-subnet-group|replication-group|serverless-cache|serverless-cache-snapshot|user|user-group',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'Message' => '<string>',
            'SourceIdentifier' => '<string>',
            'SourceType' => 'cache-cluster|cache-parameter-group|cache-security-group|cache-subnet-group|replication-group|serverless-cache|serverless-cache-snapshot|user|user-group',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeEvents

Describes all the cache-cluster events for the past 120 minutes.

$result = $client->describeEvents([
    'Duration' => 360,
    'SourceType' => 'cache-cluster',
]);

Result syntax:

[
    'Events' => [
        [
            'Date' => ,
            'Message' => 'Added cache node 0001 in availability zone us-east-1e',
            'SourceIdentifier' => 'redis-cluster',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Cache cluster created',
            'SourceIdentifier' => 'redis-cluster',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Added cache node 0002 in availability zone us-east-1c',
            'SourceIdentifier' => 'my-memcached2',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Added cache node 0001 in availability zone us-east-1e',
            'SourceIdentifier' => 'my-memcached2',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Cache cluster created',
            'SourceIdentifier' => 'my-memcached2',
            'SourceType' => 'cache-cluster',
        ],
    ],
    'Marker' => '',
]

Example 2: DescribeEvents

Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.

$result = $client->describeEvents([
    'StartTime' => ,
]);

Result syntax:

[
    'Events' => [
        [
            'Date' => ,
            'Message' => 'Snapshot succeeded for snapshot with ID 'cr-bkup' of replication group with ID 'clustered-redis'',
            'SourceIdentifier' => 'clustered-redis-0001-001',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Added cache node 0001 in availability zone us-east-1e',
            'SourceIdentifier' => 'redis-cluster',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Cache cluster created',
            'SourceIdentifier' => 'redis-cluster',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Added cache node 0002 in availability zone us-east-1c',
            'SourceIdentifier' => 'my-memcached2',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Added cache node 0001 in availability zone us-east-1e',
            'SourceIdentifier' => 'my-memcached2',
            'SourceType' => 'cache-cluster',
        ],
        [
            'Date' => ,
            'Message' => 'Cache cluster created',
            'SourceIdentifier' => 'my-memcached2',
            'SourceType' => 'cache-cluster',
        ],
    ],
    'Marker' => '',
]

DescribeGlobalReplicationGroups

$result = $client->describeGlobalReplicationGroups([/* ... */]);
$promise = $client->describeGlobalReplicationGroupsAsync([/* ... */]);

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

Parameter Syntax

$result = $client->describeGlobalReplicationGroups([
    'GlobalReplicationGroupId' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ShowMemberInfo' => true || false,
]);

Parameter Details

Result Syntax

[
    'GlobalReplicationGroups' => [
        [
            'ARN' => '<string>',
            'AtRestEncryptionEnabled' => true || false,
            'AuthTokenEnabled' => true || false,
            'CacheNodeType' => '<string>',
            'ClusterEnabled' => true || false,
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'GlobalNodeGroups' => [
                [
                    'GlobalNodeGroupId' => '<string>',
                    'Slots' => '<string>',
                ],
                // ...
            ],
            'GlobalReplicationGroupDescription' => '<string>',
            'GlobalReplicationGroupId' => '<string>',
            'Members' => [
                [
                    'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
                    'ReplicationGroupId' => '<string>',
                    'ReplicationGroupRegion' => '<string>',
                    'Role' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'Status' => '<string>',
            'TransitEncryptionEnabled' => true || false,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

GlobalReplicationGroupNotFoundFault:

The Global datastore does not exist

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DescribeReplicationGroups

$result = $client->describeReplicationGroups([/* ... */]);
$promise = $client->describeReplicationGroupsAsync([/* ... */]);

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

Parameter Syntax

$result = $client->describeReplicationGroups([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ReplicationGroupId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'ReplicationGroups' => [
        [
            'ARN' => '<string>',
            'AtRestEncryptionEnabled' => true || false,
            'AuthTokenEnabled' => true || false,
            'AuthTokenLastModifiedDate' => <DateTime>,
            'AutoMinorVersionUpgrade' => true || false,
            'AutomaticFailover' => 'enabled|disabled|enabling|disabling',
            'CacheNodeType' => '<string>',
            'ClusterEnabled' => true || false,
            'ClusterMode' => 'enabled|disabled|compatible',
            'ConfigurationEndpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
            ],
            'DataTiering' => 'enabled|disabled',
            'Description' => '<string>',
            'GlobalReplicationGroupInfo' => [
                'GlobalReplicationGroupId' => '<string>',
                'GlobalReplicationGroupMemberRole' => '<string>',
            ],
            'IpDiscovery' => 'ipv4|ipv6',
            'KmsKeyId' => '<string>',
            'LogDeliveryConfigurations' => [
                [
                    'DestinationDetails' => [
                        'CloudWatchLogsDetails' => [
                            'LogGroup' => '<string>',
                        ],
                        'KinesisFirehoseDetails' => [
                            'DeliveryStream' => '<string>',
                        ],
                    ],
                    'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                    'LogFormat' => 'text|json',
                    'LogType' => 'slow-log|engine-log',
                    'Message' => '<string>',
                    'Status' => 'active|enabling|modifying|disabling|error',
                ],
                // ...
            ],
            'MemberClusters' => ['<string>', ...],
            'MemberClustersOutpostArns' => ['<string>', ...],
            'MultiAZ' => 'enabled|disabled',
            'NetworkType' => 'ipv4|ipv6|dual_stack',
            'NodeGroups' => [
                [
                    'NodeGroupId' => '<string>',
                    'NodeGroupMembers' => [
                        [
                            'CacheClusterId' => '<string>',
                            'CacheNodeId' => '<string>',
                            'CurrentRole' => '<string>',
                            'PreferredAvailabilityZone' => '<string>',
                            'PreferredOutpostArn' => '<string>',
                            'ReadEndpoint' => [
                                'Address' => '<string>',
                                'Port' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    'PrimaryEndpoint' => [
                        'Address' => '<string>',
                        'Port' => <integer>,
                    ],
                    'ReaderEndpoint' => [
                        'Address' => '<string>',
                        'Port' => <integer>,
                    ],
                    'Slots' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'PendingModifiedValues' => [
                'AuthTokenStatus' => 'SETTING|ROTATING',
                'AutomaticFailoverStatus' => 'enabled|disabled',
                'ClusterMode' => 'enabled|disabled|compatible',
                'LogDeliveryConfigurations' => [
                    [
                        'DestinationDetails' => [
                            'CloudWatchLogsDetails' => [
                                'LogGroup' => '<string>',
                            ],
                            'KinesisFirehoseDetails' => [
                                'DeliveryStream' => '<string>',
                            ],
                        ],
                        'DestinationType' => 'cloudwatch-logs|kinesis-firehose',
                        'LogFormat' => 'text|json',
                        'LogType' => 'slow-log|engine-log',
                    ],
                    // ...
                ],
                'PrimaryClusterId' => '<string>',
                'Resharding' => [
                    'SlotMigration' => [
                        'ProgressPercentage' => <float>,
                    ],
                ],
                'TransitEncryptionEnabled' => true || false,
                'TransitEncryptionMode' => 'preferred|required',
                'UserGroups' => [
                    'UserGroupIdsToAdd' => ['<string>', ...],
                    'UserGroupIdsToRemove' => ['<string>', ...],
                ],
            ],
            'ReplicationGroupCreateTime' => <DateTime>,
            'ReplicationGroupId' => '<string>',
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'SnapshottingClusterId' => '<string>',
            'Status' => '<string>',
            'TransitEncryptionEnabled' => true || false,
            'TransitEncryptionMode' => 'preferred|required',
            'UserGroupIds' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ReplicationGroupNotFoundFault:

The specified replication group does not exist.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeReplicationGroups

Returns information about the replication group myreplgroup.

$result = $client->describeReplicationGroups([
]);

Result syntax:

[
    'Marker' => '',
    'ReplicationGroups' => [
        [
            'AutomaticFailover' => 'enabled',
            'Description' => 'Test cluster',
            'MemberClusters' => [
                'clustered-redis-0001-001',
                'clustered-redis-0001-002',
                'clustered-redis-0002-001',
                'clustered-redis-0002-002',
            ],
            'NodeGroups' => [
                [
                    'NodeGroupId' => '0001',
                    'NodeGroupMembers' => [
                        [
                            'CacheClusterId' => 'clustered-redis-0001-001',
                            'CacheNodeId' => '0001',
                            'PreferredAvailabilityZone' => 'us-east-1e',
                        ],
                        [
                            'CacheClusterId' => 'clustered-redis-0001-002',
                            'CacheNodeId' => '0001',
                            'PreferredAvailabilityZone' => 'us-east-1c',
                        ],
                    ],
                    'Status' => 'available',
                ],
                [
                    'NodeGroupId' => '0002',
                    'NodeGroupMembers' => [
                        [
                            'CacheClusterId' => 'clustered-redis-0002-001',
                            'CacheNodeId' => '0001',
                            'PreferredAvailabilityZone' => 'us-east-1c',
                        ],
                        [
                            'CacheClusterId' => 'clustered-redis-0002-002',
                            'CacheNodeId' => '0001',
                            'PreferredAvailabilityZone' => 'us-east-1b',
                        ],
                    ],
                    'Status' => 'available',
                ],
            ],
            'PendingModifiedValues' => [
            ],
            'ReplicationGroupId' => 'clustered-redis',
            'Status' => 'available',
        ],
    ],
]

DescribeReservedCacheNodes

$result = $client->describeReservedCacheNodes([/* ... */]);
$promise = $client->describeReservedCacheNodesAsync([/* ... */]);

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

Parameter Syntax

$result = $client->describeReservedCacheNodes([
    'CacheNodeType' => '<string>',
    'Duration' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'OfferingType' => '<string>',
    'ProductDescription' => '<string>',
    'ReservedCacheNodeId' => '<string>',
    'ReservedCacheNodesOfferingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'ReservedCacheNodes' => [
        [
            'CacheNodeCount' => <integer>,
            'CacheNodeType' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'OfferingType' => '<string>',
            'ProductDescription' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservationARN' => '<string>',
            'ReservedCacheNodeId' => '<string>',
            'ReservedCacheNodesOfferingId' => '<string>',
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ReservedCacheNodeNotFoundFault:

The requested reserved cache node was not found.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeReservedCacheNodes

Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.

$result = $client->describeReservedCacheNodes([
    'MaxRecords' => 25,
]);

DescribeReservedCacheNodesOfferings

$result = $client->describeReservedCacheNodesOfferings([/* ... */]);
$promise = $client->describeReservedCacheNodesOfferingsAsync([/* ... */]);

Lists available reserved cache node offerings.

Parameter Syntax

$result = $client->describeReservedCacheNodesOfferings([
    'CacheNodeType' => '<string>',
    'Duration' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'OfferingType' => '<string>',
    'ProductDescription' => '<string>',
    'ReservedCacheNodesOfferingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'ReservedCacheNodesOfferings' => [
        [
            'CacheNodeType' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'OfferingType' => '<string>',
            'ProductDescription' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedCacheNodesOfferingId' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ReservedCacheNodesOfferingNotFoundFault:

The requested cache node offering does not exist.

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

Examples

Example 1: DescribeReseredCacheNodeOfferings

Lists available reserved cache node offerings.

$result = $client->describeReservedCacheNodesOfferings([
    'MaxRecords' => 20,
]);

Result syntax:

[
    'Marker' => '1ef01f5b-433f-94ff-a530-61a56bfc8e7a',
    'ReservedCacheNodesOfferings' => [
        [
            'CacheNodeType' => 'cache.m1.small',
            'Duration' => 94608000,
            'FixedPrice' => 157,
            'OfferingType' => 'Medium Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '0167633d-37f6-4222-b872-b1f22eb79ba4',
            'UsagePrice' => 0.017,
        ],
        [
            'CacheNodeType' => 'cache.m4.xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 1248,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.077,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '02c04e13-baca-4e71-9ceb-620eed94827d',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.m2.4xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 2381,
            'OfferingType' => 'Medium Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '02e1755e-76e8-48e3-8d82-820a5726a458',
            'UsagePrice' => 0.276,
        ],
        [
            'CacheNodeType' => 'cache.m1.small',
            'Duration' => 94608000,
            'FixedPrice' => 188,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.013,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '03315215-7b87-421a-a3dd-785021e4113f',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.m4.10xlarge',
            'Duration' => 31536000,
            'FixedPrice' => 6158,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 1.125,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '05ffbb44-2ace-4476-a2a5-8ec99f866fb3',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.m1.small',
            'Duration' => 31536000,
            'FixedPrice' => 101,
            'OfferingType' => 'Medium Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '065c71ae-4a4e-4f1e-bebf-37525f4c6cb2',
            'UsagePrice' => 0.023,
        ],
        [
            'CacheNodeType' => 'cache.m1.medium',
            'Duration' => 94608000,
            'FixedPrice' => 314,
            'OfferingType' => 'Medium Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '06774b12-7f5e-48c1-907a-f286c63f327d',
            'UsagePrice' => 0.034,
        ],
        [
            'CacheNodeType' => 'cache.m2.xlarge',
            'Duration' => 31536000,
            'FixedPrice' => 163,
            'OfferingType' => 'Light Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '0924ac6b-847f-4761-ba6b-4290b2adf719',
            'UsagePrice' => 0.137,
        ],
        [
            'CacheNodeType' => 'cache.m2.xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 719,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.049,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '09eeb126-69b6-4d3f-8f94-ca3510629f53',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.r3.2xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 4132,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.182,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '0a516ad8-557f-4310-9dd0-2448c2ff4d62',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.c1.xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 875,
            'OfferingType' => 'Light Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '0b0c1cc5-2177-4150-95d7-c67ec34dcb19',
            'UsagePrice' => 0.363,
        ],
        [
            'CacheNodeType' => 'cache.m4.10xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 12483,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.76,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '0c2b139b-1cff-43d0-8fba-0c753f9b1950',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.c1.xlarge',
            'Duration' => 31536000,
            'FixedPrice' => 1620,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.207,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '0c52115b-38cb-47a2-8dbc-e02e40b6a13f',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.m2.4xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 2381,
            'OfferingType' => 'Medium Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '12fcb19c-5416-4e1d-934f-28f1e2cb8599',
            'UsagePrice' => 0.276,
        ],
        [
            'CacheNodeType' => 'cache.m4.xlarge',
            'Duration' => 31536000,
            'FixedPrice' => 616,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.112,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '13af20ad-914d-4d8b-9763-fa2e565f3549',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.r3.8xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 16528,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.729,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '14da3d3f-b526-4dbf-b09b-355578b2a576',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.m1.medium',
            'Duration' => 94608000,
            'FixedPrice' => 140,
            'OfferingType' => 'Light Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '15d7018c-71fb-4717-8409-4bdcdca18da7',
            'UsagePrice' => 0.052,
        ],
        [
            'CacheNodeType' => 'cache.m4.4xlarge',
            'Duration' => 94608000,
            'FixedPrice' => 4993,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.304,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '1ae7ec5f-a76e-49b6-822b-629b1768a13a',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.m3.2xlarge',
            'Duration' => 31536000,
            'FixedPrice' => 1772,
            'OfferingType' => 'Heavy Utilization',
            'ProductDescription' => 'redis',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => 0.25,
                    'RecurringChargeFrequency' => 'Hourly',
                ],
            ],
            'ReservedCacheNodesOfferingId' => '1d31242b-3925-48d1-b882-ce03204e6013',
            'UsagePrice' => 0,
        ],
        [
            'CacheNodeType' => 'cache.t1.micro',
            'Duration' => 31536000,
            'FixedPrice' => 54,
            'OfferingType' => 'Medium Utilization',
            'ProductDescription' => 'memcached',
            'RecurringCharges' => [
            ],
            'ReservedCacheNodesOfferingId' => '1ef01f5b-94ff-433f-a530-61a56bfc8e7a',
            'UsagePrice' => 0.008,
        ],
    ],
]

Example 2: DescribeReseredCacheNodeOfferings

Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.

$result = $client->describeReservedCacheNodesOfferings([
    'CacheNodeType' => 'cache.r3.large',
    'Duration' => '3',
    'MaxRecords' => 25,
    'OfferingType' => 'Light Utilization',
    'ReservedCacheNodesOfferingId' => '',
]);

Result syntax:

[
    'Marker' => '',
    'ReservedCacheNodesOfferings' => [
    ],
]

Example 3: DescribeReseredCacheNodeOfferings

Lists available reserved cache node offerings.

$result = $client->describeReservedCacheNodesOfferings([
    'CacheNodeType' => '',
    'Duration' => '',
    'Marker' => '',
    'MaxRecords' => 25,
    'OfferingType' => '',
    'ProductDescription' => '',
    'ReservedCacheNodesOfferingId' => '438012d3-4052-4cc7-b2e3-8d3372e0e706',
]);

Result syntax:

[
    'Marker' => '',
    'ReservedCacheNodesOfferings' => [
    ],
]

DescribeServerlessCacheSnapshots

$result = $client->describeServerlessCacheSnapshots([/* ... */]);
$promise = $client->describeServerlessCacheSnapshotsAsync([/* ... */]);

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only.

Parameter Syntax

$result = $client->describeServerlessCacheSnapshots([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServerlessCacheName' => '<string>',
    'ServerlessCacheSnapshotName' => '<string>',
    'SnapshotType' => '<string>',
]);

Parameter Details