Amazon ElastiCache
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
elasticache( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint : The complete URL to use for the constructed client.
region : The AWS Region used in instantiating the client.
close_connection : Immediately close all HTTP connections.
timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.
svc <- elasticache(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_tags_to_resource | A tag is a key-value pair where the key and value are case-sensitive |
| authorize_cache_security_group_ingress | Allows network ingress to a cache security group |
| batch_apply_update_action | Apply the service update |
| batch_stop_update_action | Stop the service update |
| complete_migration | Complete the migration of data |
| copy_serverless_cache_snapshot | Creates a copy of an existing serverless cache’s snapshot |
| copy_snapshot | Makes a copy of an existing snapshot |
| create_cache_cluster | Creates a cluster |
| create_cache_parameter_group | Creates a new Amazon ElastiCache cache parameter group |
| create_cache_security_group | Creates a new cache security group |
| create_cache_subnet_group | Creates a new cache subnet group |
| create_global_replication_group | Global Datastore offers fully managed, fast, reliable and secure cross-region replication |
| create_replication_group | Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group |
| create_serverless_cache | Creates a serverless cache |
| create_serverless_cache_snapshot | This API creates a copy of an entire ServerlessCache at a specific moment in time |
| create_snapshot | Creates a copy of an entire cluster or replication group at a specific moment in time |
| create_user | For Valkey engine version 7 |
| create_user_group | For Valkey engine version 7 |
| decrease_node_groups_in_global_replication_group | Decreases the number of node groups in a Global datastore |
| decrease_replica_count | Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group |
| delete_cache_cluster | Deletes a previously provisioned cluster |
| delete_cache_parameter_group | Deletes the specified cache parameter group |
| delete_cache_security_group | Deletes a cache security group |
| delete_cache_subnet_group | Deletes a cache subnet group |
| delete_global_replication_group | Deleting a Global datastore is a two-step process: |
| delete_replication_group | Deletes an existing replication group |
| delete_serverless_cache | Deletes a specified existing serverless cache |
| delete_serverless_cache_snapshot | Deletes an existing serverless cache snapshot |
| delete_snapshot | Deletes an existing snapshot |
| delete_user | For Valkey engine version 7 |
| delete_user_group | For Valkey engine version 7 |
| describe_cache_clusters | Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied |
| describe_cache_engine_versions | Returns a list of the available cache engines and their versions |
| describe_cache_parameter_groups | Returns a list of cache parameter group descriptions |
| describe_cache_parameters | Returns the detailed parameter list for a particular cache parameter group |
| describe_cache_security_groups | Returns a list of cache security group descriptions |
| describe_cache_subnet_groups | Returns a list of cache subnet group descriptions |
| describe_engine_default_parameters | Returns the default engine and system parameter information for the specified cache engine |
| describe_events | Returns events related to clusters, cache security groups, and cache parameter groups |
| describe_global_replication_groups | Returns information about a particular global replication group |
| describe_replication_groups | Returns information about a particular replication group |
| describe_reserved_cache_nodes | Returns information about reserved cache nodes for this account, or about a specified reserved cache node |
| describe_reserved_cache_nodes_offerings | Lists available reserved cache node offerings |
| describe_serverless_caches | Returns information about a specific serverless cache |
| describe_serverless_cache_snapshots | Returns information about serverless cache snapshots |
| describe_service_updates | Returns details of the service updates |
| describe_snapshots | Returns information about cluster or replication group snapshots |
| describe_update_actions | Returns details of the update actions |
| describe_user_groups | Returns a list of user groups |
| describe_users | Returns a list of users |
| disassociate_global_replication_group | Remove a secondary cluster from the Global datastore using the Global datastore name |
| export_serverless_cache_snapshot | Provides the functionality to export the serverless cache snapshot data to Amazon S3 |
| failover_global_replication_group | Used to failover the primary region to a secondary region |
| increase_node_groups_in_global_replication_group | Increase the number of node groups in the Global datastore |
| increase_replica_count | Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group |
| list_allowed_node_type_modifications | Lists all available node types that you can scale with your cluster's replication group's current node type |
| list_tags_for_resource | Lists all tags currently on a named resource |
| modify_cache_cluster | Modifies the settings for a cluster |
| modify_cache_parameter_group | Modifies the parameters of a cache parameter group |
| modify_cache_subnet_group | Modifies an existing cache subnet group |
| modify_global_replication_group | Modifies the settings for a Global datastore |
| modify_replication_group | Modifies the settings for a replication group |
| modify_replication_group_shard_configuration | Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards |
| modify_serverless_cache | This API modifies the attributes of a serverless cache |
| modify_user | Changes user password(s) and/or access string |
| modify_user_group | Changes the list of users that belong to the user group |
| purchase_reserved_cache_nodes_offering | Allows you to purchase a reserved cache node offering |
| rebalance_slots_in_global_replication_group | Redistribute slots to ensure uniform distribution across existing shards in the cluster |
| reboot_cache_cluster | Reboots some, or all, of the cache nodes within a provisioned cluster |
| remove_tags_from_resource | Removes the tags identified by the TagKeys list from the named resource |
| reset_cache_parameter_group | Modifies the parameters of a cache parameter group to the engine or system default value |
| revoke_cache_security_group_ingress | Revokes ingress from a cache security group |
| start_migration | Start the migration of data |
| test_failover | Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console) |
| test_migration | Async API to test connection between source and target replication group |
## Not run: svc <- elasticache() # Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource. svc$add_tags_to_resource( ResourceName = "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", Tags = list( list( Key = "APIVersion", Value = "20150202" ), list( Key = "Service", Value = "ElastiCache" ) ) ) ## End(Not run)
Useful links