Skip to content

Creates a serverless cache

Description

Creates a serverless cache.

Usage

elasticache_create_serverless_cache(ServerlessCacheName, Description,
  Engine, MajorEngineVersion, CacheUsageLimits, KmsKeyId,
  SecurityGroupIds, SnapshotArnsToRestore, Tags, UserGroupId, SubnetIds,
  SnapshotRetentionLimit, DailySnapshotTime, NetworkType, ConnectionType)

Arguments

  • ServerlessCacheName

    [required] User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.

  • Description

    User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.

  • Engine

    [required] The name of the cache engine to be used for creating the serverless cache.

  • MajorEngineVersion

    The version of the cache engine that will be used to create the serverless cache.

  • CacheUsageLimits

    Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.

  • KmsKeyId

    ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.

  • SecurityGroupIds

    A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.

  • SnapshotArnsToRestore

    The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.

  • Tags

    The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.

  • UserGroupId

    The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

  • SubnetIds

    A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.

  • SnapshotRetentionLimit

    The number of days for which ElastiCache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days.

  • DailySnapshotTime

    The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

  • NetworkType

    The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.

  • ConnectionType

    The connection type for the serverless cache. Must be either vpc | public. Use vpc to access the cache through a VPC endpoint, or public to access the cache over the internet. If not specified, defaults to vpc. This value cannot be changed after the serverless cache is created. Setting this to public requires Valkey 9 or above.

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",
    StorageEncryptionType = "none"|"sse-elasticache"|"sse-kms",
    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",
    NetworkType = "ipv4"|"ipv6"|"dual_stack",
    ConnectionType = "vpc"|"public"
  )
)

Request syntax

svc$create_serverless_cache(
  ServerlessCacheName = "string",
  Description = "string",
  Engine = "string",
  MajorEngineVersion = "string",
  CacheUsageLimits = list(
    DataStorage = list(
      Maximum = 123,
      Minimum = 123,
      Unit = "GB"
    ),
    ECPUPerSecond = list(
      Maximum = 123,
      Minimum = 123
    )
  ),
  KmsKeyId = "string",
  SecurityGroupIds = list(
    "string"
  ),
  SnapshotArnsToRestore = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  UserGroupId = "string",
  SubnetIds = list(
    "string"
  ),
  SnapshotRetentionLimit = 123,
  DailySnapshotTime = "string",
  NetworkType = "ipv4"|"ipv6"|"dual_stack",
  ConnectionType = "vpc"|"public"
)