Modify Serverless Cache

elasticache_modify_serverless_cache

R Documentation

This API modifies the attributes of a serverless cache

Description

This API modifies the attributes of a serverless cache.

Usage

elasticache_modify_serverless_cache(ServerlessCacheName, Description,
  CacheUsageLimits, RemoveUserGroup, UserGroupId, SecurityGroupIds,
  SnapshotRetentionLimit, DailySnapshotTime)

Arguments

ServerlessCacheName

[required] User-provided identifier for the serverless cache to be modified.

Description

User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.

CacheUsageLimits

Modify the cache usage limit for the serverless cache.

RemoveUserGroup

The identifier of the UserGroup to be removed from association with the Redis OSS serverless cache. Available for Redis OSS only. Default is NULL.

UserGroupId

The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. Default is NULL - the existing UserGroup is not removed.

SecurityGroupIds

The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.

SnapshotRetentionLimit

The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

DailySnapshotTime

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

Value

A list with the following syntax:

list(
  ServerlessCache = list(
    ServerlessCacheName = "string",
    Description = "string",
    CreateTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "string",
    Engine = "string",
    MajorEngineVersion = "string",
    FullEngineVersion = "string",
    CacheUsageLimits = list(
      DataStorage = list(
        Maximum = 123,
        Minimum = 123,
        Unit = "GB"
      ),
      ECPUPerSecond = list(
        Maximum = 123,
        Minimum = 123
      )
    ),
    KmsKeyId = "string",
    SecurityGroupIds = list(
      "string"
    ),
    Endpoint = list(
      Address = "string",
      Port = 123
    ),
    ReaderEndpoint = list(
      Address = "string",
      Port = 123
    ),
    ARN = "string",
    UserGroupId = "string",
    SubnetIds = list(
      "string"
    ),
    SnapshotRetentionLimit = 123,
    DailySnapshotTime = "string"
  )
)

Request syntax

svc$modify_serverless_cache(
  ServerlessCacheName = "string",
  Description = "string",
  CacheUsageLimits = list(
    DataStorage = list(
      Maximum = 123,
      Minimum = 123,
      Unit = "GB"
    ),
    ECPUPerSecond = list(
      Maximum = 123,
      Minimum = 123
    )
  ),
  RemoveUserGroup = TRUE|FALSE,
  UserGroupId = "string",
  SecurityGroupIds = list(
    "string"
  ),
  SnapshotRetentionLimit = 123,
  DailySnapshotTime = "string"
)