Amazon ElastiCache Elasticache Serverless Cache API

openapi: 3.2.0
info:
  title: Amazon ElastiCache Serverless Cache API
  version: '2015-02-02'
  description: Generated from AWS's published Smithy model for Amazon ElastiCache. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticache.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Serverless Cache
paths:
  /?Action=CreateServerlessCache:
    post:
      operationId: CreateServerlessCache
      summary: Create Serverless Cache
      description: Creates a serverless cache.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateServerlessCacheResponse'
        '408':
          description: InvalidCredentialsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidCredentialsException'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidServerlessCacheStateFault; InvalidUserGroupStateFault; ServerlessCacheAlreadyExistsFault; ServerlessCacheQuotaForCustomerExceededFault; ServiceLinkedRoleNotFoundFault; TagQuotaPerResourceExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: ServerlessCacheNotFoundFault; UserGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateServerlessCache
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/CreateServerlessCacheRequest'
      tags:
      - Serverless Cache
  /?Action=DeleteServerlessCache:
    post:
      operationId: DeleteServerlessCache
      summary: Delete Serverless Cache
      description: Deletes a specified existing serverless cache. CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteServerlessCacheResponse'
        '408':
          description: InvalidCredentialsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidCredentialsException'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidServerlessCacheStateFault; ServerlessCacheSnapshotAlreadyExistsFault; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: ServerlessCacheNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteServerlessCache
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DeleteServerlessCacheRequest'
      tags:
      - Serverless Cache
  /?Action=DescribeServerlessCaches:
    post:
      operationId: DescribeServerlessCaches
      summary: Describe Serverless Caches
      description: Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeServerlessCachesResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: ServerlessCacheNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeServerlessCaches
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DescribeServerlessCachesRequest'
      tags:
      - Serverless Cache
  /?Action=ModifyServerlessCache:
    post:
      operationId: ModifyServerlessCache
      summary: Modify Serverless Cache
      description: This API modifies the attributes of a serverless cache.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyServerlessCacheResponse'
        '408':
          description: InvalidCredentialsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidCredentialsException'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidServerlessCacheStateFault; InvalidUserGroupStateFault; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: ServerlessCacheNotFoundFault; UserGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyServerlessCache
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/ModifyServerlessCacheRequest'
      tags:
      - Serverless Cache
components:
  schemas:
    ServerlessCache:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: The unique identifier of the serverless cache.
        Description:
          type: string
          description: A description of the serverless cache.
        CreateTime:
          type: string
          format: date-time
          description: When the serverless cache was created.
        Status:
          type: string
          description: The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
        Engine:
          type: string
          description: The engine the serverless cache is compatible with.
        MajorEngineVersion:
          type: string
          description: The version number of the engine the serverless cache is compatible with.
        FullEngineVersion:
          type: string
          description: The name and version number of the engine the serverless cache is compatible with.
        CacheUsageLimits:
          $ref: '#/components/schemas/CacheUsageLimits'
        KmsKeyId:
          type: string
          description: The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
        StorageEncryptionType:
          type: string
          enum:
          - none
          - sse-elasticache
          - sse-kms
          description: Indicates the type of encryption for data stored at rest in the serverless cache. Serverless caches are always encrypted at rest. The value is sse-elasticache if an ElastiCache service-managed key is used, or sse-kms if a customer-managed KMS key is used.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The IDs of the EC2 security groups associated with the serverless cache.
        Endpoint:
          $ref: '#/components/schemas/Endpoint'
        ReaderEndpoint:
          $ref: '#/components/schemas/Endpoint'
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of the serverless cache.
        UserGroupId:
          type: string
          description: The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
        SubnetIds:
          type: array
          items:
            type: string
          description: If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
        SnapshotRetentionLimit:
          type: integer
          description: 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:
          type: string
          description: The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
        NetworkType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dual_stack
          description: The type of IP address protocol 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:
          type: string
          enum:
          - vpc
          - public
          description: The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
        Migration:
          $ref: '#/components/schemas/MigrationSummary'
    Endpoint:
      type: object
      properties:
        Address:
          type: string
          description: The DNS hostname of the cache node.
        Port:
          type: integer
          description: The port number that the cache engine is listening on.
    DescribeServerlessCachesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.
        ServerlessCaches:
          type: array
          items:
            $ref: '#/components/schemas/ServerlessCache'
          description: The serverless caches associated with a given description request.
    ModifyServerlessCacheResponse:
      type: object
      properties:
        ServerlessCache:
          $ref: '#/components/schemas/ServerlessCache'
    ServerlessCacheNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DescribeServerlessCachesRequest:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: 'The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL'
        MaxResults:
          type: integer
          description: The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.
        NextToken:
          type: string
          description: An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.
    InvalidCredentialsException:
      type: object
      properties:
        message:
          type: string
    CacheUsageLimits:
      type: object
      properties:
        DataStorage:
          $ref: '#/components/schemas/DataStorage'
        ECPUPerSecond:
          $ref: '#/components/schemas/ECPUPerSecond'
    DataStorage:
      type: object
      properties:
        Maximum:
          type: integer
          description: The upper limit for data storage the cache is set to use.
        Minimum:
          type: integer
          description: The lower limit for data storage the cache is set to use.
        Unit:
          type: string
          enum:
          - GB
          description: The unit that the storage is measured in, in GB.
      required:
      - Unit
    CreateServerlessCacheRequest:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
        Description:
          type: 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:
          type: string
          description: The name of the cache engine to be used for creating the serverless cache.
        MajorEngineVersion:
          type: string
          description: The version of the cache engine that will be used to create the serverless cache.
        CacheUsageLimits:
          $ref: '#/components/schemas/CacheUsageLimits'
        KmsKeyId:
          type: string
          description: 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:
          type: array
          items:
            type: string
          description: 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:
          type: array
          items:
            type: string
          description: 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:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
        UserGroupId:
          type: string
          description: The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
        SubnetIds:
          type: array
          items:
            type: string
          description: 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:
          type: integer
          description: 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:
          type: string
          description: 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:
          type: string
          enum:
          - ipv4
          - ipv6
          - dual_stack
          description: 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:
          type: string
          enum:
          - vpc
          - public
          description: 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.
      required:
      - ServerlessCacheName
      - Engine
    CreateServerlessCacheResponse:
      type: object
      properties:
        ServerlessCache:
          $ref: '#/components/schemas/ServerlessCache'
    ECPUPerSecond:
      type: object
      properties:
        Maximum:
          type: integer
          description: The configuration for the maximum number of ECPUs the cache can consume per second.
        Minimum:
          type: integer
          description: The configuration for the minimum number of ECPUs the cache should be able consume per second.
    MigrationSummary:
      type: object
      properties:
        Status:
          type: string
          description: The current status of the migration.
        MigrationEndpoint:
          $ref: '#/components/schemas/Endpoint'
        CutoverMode:
          type: string
          description: The cutover configuration for the migration.
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
          description: Two or more parameters that must not be used together were used together.
    DeleteServerlessCacheResponse:
      type: object
      properties:
        ServerlessCache:
          $ref: '#/components/schemas/ServerlessCache'
    ModifyServerlessCacheRequest:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: User-provided identifier for the serverless cache to be modified.
        Description:
          type: string
          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:
          $ref: '#/components/schemas/CacheUsageLimits'
        RemoveUserGroup:
          type: boolean
          description: The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
        UserGroupId:
          type: string
          description: The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: 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:
          type: integer
          description: The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, 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:
          type: string
          description: The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
        Engine:
          type: string
          description: Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.
        MajorEngineVersion:
          type: string
          description: Modifies the engine vesion listed in a serverless cache request.
      required:
      - ServerlessCacheName
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag. May not be null.
        Value:
          type: string
          description: The tag's value. May be null.
    DeleteServerlessCacheRequest:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: The identifier of the serverless cache to be deleted.
        FinalSnapshotName:
          type: string
          description: 'Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL, i.e. a final snapshot is not taken.'
      required:
      - ServerlessCacheName
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: elasticache
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elasticache/service/2015-02-02/elasticache-2015-02-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)