Documentation

ElastiCacheClient extends AwsClient
in package

This client is used to interact with the **Amazon ElastiCache** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
addTagsToResource()  :
addTagsToResourceAsync()  :
authorizeCacheSecurityGroupIngress()  :
authorizeCacheSecurityGroupIngressAsync()  :
batchApplyUpdateAction()  :
batchApplyUpdateActionAsync()  :
batchStopUpdateAction()  :
batchStopUpdateActionAsync()  :
completeMigration()  :
completeMigrationAsync()  :
copySnapshot()  :
copySnapshotAsync()  :
createCacheCluster()  :
createCacheClusterAsync()  :
createCacheParameterGroup()  :
createCacheParameterGroupAsync()  :
createCacheSecurityGroup()  :
createCacheSecurityGroupAsync()  :
createCacheSubnetGroup()  :
createCacheSubnetGroupAsync()  :
createGlobalReplicationGroup()  :
createGlobalReplicationGroupAsync()  :
createReplicationGroup()  :
createReplicationGroupAsync()  :
createSnapshot()  :
createSnapshotAsync()  :
createUser()  :
createUserAsync()  :
createUserGroup()  :
createUserGroupAsync()  :
decreaseNodeGroupsInGlobalReplicationGroup()  :
decreaseNodeGroupsInGlobalReplicationGroupAsync()  :
decreaseReplicaCount()  :
decreaseReplicaCountAsync()  :
deleteCacheCluster()  :
deleteCacheClusterAsync()  :
deleteCacheParameterGroup()  :
deleteCacheParameterGroupAsync()  :
deleteCacheSecurityGroup()  :
deleteCacheSecurityGroupAsync()  :
deleteCacheSubnetGroup()  :
deleteCacheSubnetGroupAsync()  :
deleteGlobalReplicationGroup()  :
deleteGlobalReplicationGroupAsync()  :
deleteReplicationGroup()  :
deleteReplicationGroupAsync()  :
deleteSnapshot()  :
deleteSnapshotAsync()  :
deleteUser()  :
deleteUserAsync()  :
deleteUserGroup()  :
deleteUserGroupAsync()  :
describeCacheClusters()  :
describeCacheClustersAsync()  :
describeCacheEngineVersions()  :
describeCacheEngineVersionsAsync()  :
describeCacheParameterGroups()  :
describeCacheParameterGroupsAsync()  :
describeCacheParameters()  :
describeCacheParametersAsync()  :
describeCacheSecurityGroups()  :
describeCacheSecurityGroupsAsync()  :
describeCacheSubnetGroups()  :
describeCacheSubnetGroupsAsync()  :
describeEngineDefaultParameters()  :
describeEngineDefaultParametersAsync()  :
describeEvents()  :
describeEventsAsync()  :
describeGlobalReplicationGroups()  :
describeGlobalReplicationGroupsAsync()  :
describeReplicationGroups()  :
describeReplicationGroupsAsync()  :
describeReservedCacheNodes()  :
describeReservedCacheNodesAsync()  :
describeReservedCacheNodesOfferings()  :
describeReservedCacheNodesOfferingsAsync()  :
describeServiceUpdates()  :
describeServiceUpdatesAsync()  :
describeSnapshots()  :
describeSnapshotsAsync()  :
describeUpdateActions()  :
describeUpdateActionsAsync()  :
describeUserGroups()  :
describeUserGroupsAsync()  :
describeUsers()  :
describeUsersAsync()  :
disassociateGlobalReplicationGroup()  :
disassociateGlobalReplicationGroupAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
failoverGlobalReplicationGroup()  :
failoverGlobalReplicationGroupAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
increaseNodeGroupsInGlobalReplicationGroup()  :
increaseNodeGroupsInGlobalReplicationGroupAsync()  :
increaseReplicaCount()  :
increaseReplicaCountAsync()  :
listAllowedNodeTypeModifications()  :
listAllowedNodeTypeModificationsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
modifyCacheCluster()  :
modifyCacheClusterAsync()  :
modifyCacheParameterGroup()  :
modifyCacheParameterGroupAsync()  :
modifyCacheSubnetGroup()  :
modifyCacheSubnetGroupAsync()  :
modifyGlobalReplicationGroup()  :
modifyGlobalReplicationGroupAsync()  :
modifyReplicationGroup()  :
modifyReplicationGroupAsync()  :
modifyReplicationGroupShardConfiguration()  :
modifyReplicationGroupShardConfigurationAsync()  :
modifyUser()  :
modifyUserAsync()  :
modifyUserGroup()  :
modifyUserGroupAsync()  :
purchaseReservedCacheNodesOffering()  :
purchaseReservedCacheNodesOfferingAsync()  :
rebalanceSlotsInGlobalReplicationGroup()  :
rebalanceSlotsInGlobalReplicationGroupAsync()  :
rebootCacheCluster()  :
rebootCacheClusterAsync()  :
removeTagsFromResource()  :
removeTagsFromResourceAsync()  :
resetCacheParameterGroup()  :
resetCacheParameterGroupAsync()  :
revokeCacheSecurityGroupIngress()  :
revokeCacheSecurityGroupIngressAsync()  :
startMigration()  :
startMigrationAsync()  :
testFailover()  :
testFailoverAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
mixed —

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

addTagsToResource()

public addTagsToResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

addTagsToResourceAsync()

public addTagsToResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

authorizeCacheSecurityGroupIngress()

public authorizeCacheSecurityGroupIngress(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

authorizeCacheSecurityGroupIngressAsync()

public authorizeCacheSecurityGroupIngressAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchApplyUpdateAction()

public batchApplyUpdateAction(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchApplyUpdateActionAsync()

public batchApplyUpdateActionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchStopUpdateAction()

public batchStopUpdateAction(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchStopUpdateActionAsync()

public batchStopUpdateActionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

completeMigration()

public completeMigration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

completeMigrationAsync()

public completeMigrationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

copySnapshot()

public copySnapshot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

copySnapshotAsync()

public copySnapshotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheCluster()

public createCacheCluster(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheClusterAsync()

public createCacheClusterAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheParameterGroup()

public createCacheParameterGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheParameterGroupAsync()

public createCacheParameterGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheSecurityGroup()

public createCacheSecurityGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheSecurityGroupAsync()

public createCacheSecurityGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheSubnetGroup()

public createCacheSubnetGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCacheSubnetGroupAsync()

public createCacheSubnetGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGlobalReplicationGroup()

public createGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGlobalReplicationGroupAsync()

public createGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createReplicationGroup()

public createReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createReplicationGroupAsync()

public createReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSnapshot()

public createSnapshot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSnapshotAsync()

public createSnapshotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createUser()

public createUser(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createUserAsync()

public createUserAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createUserGroup()

public createUserGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createUserGroupAsync()

public createUserGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

decreaseNodeGroupsInGlobalReplicationGroup()

public decreaseNodeGroupsInGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

decreaseNodeGroupsInGlobalReplicationGroupAsync()

public decreaseNodeGroupsInGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

decreaseReplicaCount()

public decreaseReplicaCount(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

decreaseReplicaCountAsync()

public decreaseReplicaCountAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheCluster()

public deleteCacheCluster(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheClusterAsync()

public deleteCacheClusterAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheParameterGroup()

public deleteCacheParameterGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheParameterGroupAsync()

public deleteCacheParameterGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheSecurityGroup()

public deleteCacheSecurityGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheSecurityGroupAsync()

public deleteCacheSecurityGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheSubnetGroup()

public deleteCacheSubnetGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCacheSubnetGroupAsync()

public deleteCacheSubnetGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteGlobalReplicationGroup()

public deleteGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteGlobalReplicationGroupAsync()

public deleteGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteReplicationGroup()

public deleteReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteReplicationGroupAsync()

public deleteReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteSnapshot()

public deleteSnapshot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteSnapshotAsync()

public deleteSnapshotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteUser()

public deleteUser(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteUserAsync()

public deleteUserAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteUserGroup()

public deleteUserGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteUserGroupAsync()

public deleteUserGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheClusters()

public describeCacheClusters(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheClustersAsync()

public describeCacheClustersAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheEngineVersions()

public describeCacheEngineVersions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheEngineVersionsAsync()

public describeCacheEngineVersionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheParameterGroups()

public describeCacheParameterGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheParameterGroupsAsync()

public describeCacheParameterGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheParameters()

public describeCacheParameters(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheParametersAsync()

public describeCacheParametersAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheSecurityGroups()

public describeCacheSecurityGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheSecurityGroupsAsync()

public describeCacheSecurityGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheSubnetGroups()

public describeCacheSubnetGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeCacheSubnetGroupsAsync()

public describeCacheSubnetGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEngineDefaultParameters()

public describeEngineDefaultParameters(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEngineDefaultParametersAsync()

public describeEngineDefaultParametersAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEvents()

public describeEvents(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEventsAsync()

public describeEventsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGlobalReplicationGroups()

public describeGlobalReplicationGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGlobalReplicationGroupsAsync()

public describeGlobalReplicationGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeReplicationGroups()

public describeReplicationGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeReplicationGroupsAsync()

public describeReplicationGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeReservedCacheNodes()

public describeReservedCacheNodes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeReservedCacheNodesAsync()

public describeReservedCacheNodesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeReservedCacheNodesOfferings()

public describeReservedCacheNodesOfferings(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeReservedCacheNodesOfferingsAsync()

public describeReservedCacheNodesOfferingsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeServiceUpdates()

public describeServiceUpdates(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeServiceUpdatesAsync()

public describeServiceUpdatesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSnapshots()

public describeSnapshots(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSnapshotsAsync()

public describeSnapshotsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeUpdateActions()

public describeUpdateActions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeUpdateActionsAsync()

public describeUpdateActionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeUserGroups()

public describeUserGroups(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeUserGroupsAsync()

public describeUserGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeUsers()

public describeUsers(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeUsersAsync()

public describeUsersAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

disassociateGlobalReplicationGroup()

public disassociateGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

disassociateGlobalReplicationGroupAsync()

public disassociateGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

failoverGlobalReplicationGroup()

public failoverGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

failoverGlobalReplicationGroupAsync()

public failoverGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null —

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface —

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList —

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

increaseNodeGroupsInGlobalReplicationGroup()

public increaseNodeGroupsInGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

increaseNodeGroupsInGlobalReplicationGroupAsync()

public increaseNodeGroupsInGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

increaseReplicaCount()

public increaseReplicaCount(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

increaseReplicaCountAsync()

public increaseReplicaCountAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listAllowedNodeTypeModifications()

public listAllowedNodeTypeModifications(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listAllowedNodeTypeModificationsAsync()

public listAllowedNodeTypeModificationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyCacheCluster()

public modifyCacheCluster(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyCacheClusterAsync()

public modifyCacheClusterAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyCacheParameterGroup()

public modifyCacheParameterGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyCacheParameterGroupAsync()

public modifyCacheParameterGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyCacheSubnetGroup()

public modifyCacheSubnetGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyCacheSubnetGroupAsync()

public modifyCacheSubnetGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyGlobalReplicationGroup()

public modifyGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyGlobalReplicationGroupAsync()

public modifyGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyReplicationGroup()

public modifyReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyReplicationGroupAsync()

public modifyReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyReplicationGroupShardConfiguration()

public modifyReplicationGroupShardConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyReplicationGroupShardConfigurationAsync()

public modifyReplicationGroupShardConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyUser()

public modifyUser(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyUserAsync()

public modifyUserAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyUserGroup()

public modifyUserGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

modifyUserGroupAsync()

public modifyUserGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

purchaseReservedCacheNodesOffering()

public purchaseReservedCacheNodesOffering(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

purchaseReservedCacheNodesOfferingAsync()

public purchaseReservedCacheNodesOfferingAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

rebalanceSlotsInGlobalReplicationGroup()

public rebalanceSlotsInGlobalReplicationGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

rebalanceSlotsInGlobalReplicationGroupAsync()

public rebalanceSlotsInGlobalReplicationGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

rebootCacheCluster()

public rebootCacheCluster(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

rebootCacheClusterAsync()

public rebootCacheClusterAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

removeTagsFromResource()

public removeTagsFromResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

removeTagsFromResourceAsync()

public removeTagsFromResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

resetCacheParameterGroup()

public resetCacheParameterGroup(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

resetCacheParameterGroupAsync()

public resetCacheParameterGroupAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

revokeCacheSecurityGroupIngress()

public revokeCacheSecurityGroupIngress(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

revokeCacheSecurityGroupIngressAsync()

public revokeCacheSecurityGroupIngressAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startMigration()

public startMigration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startMigrationAsync()

public startMigrationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

testFailover()

public testFailover(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

testFailoverAsync()

public testFailoverAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results