Amazon ElastiCache Elasticache Snapshot API

openapi: 3.2.0
info:
  title: Amazon ElastiCache Snapshot API
  version: '2015-02-02'
  description: Generated from AWS's published Smithy model for Amazon ElastiCache. 3 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: Snapshot
paths:
  /?Action=CreateSnapshot:
    post:
      operationId: CreateSnapshot
      summary: Create Snapshot
      description: Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Valkey or Redis OSS only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateSnapshotResult'
              example:
                Snapshot:
                  Engine: redis
                  CacheParameterGroupName: default.redis3.2
                  VpcId: vpc-73c3cd17
                  CacheClusterId: threenoderedis-001
                  SnapshotRetentionLimit: 1
                  NumCacheNodes: 1
                  SnapshotName: snapshot-2
                  CacheClusterCreateTime: '2017-02-03T15:43:36.278Z'
                  AutoMinorVersionUpgrade: true
                  PreferredAvailabilityZone: us-west-2c
                  SnapshotStatus: creating
                  SnapshotSource: manual
                  SnapshotWindow: 00:00-01:00
                  EngineVersion: 3.2.4
                  NodeSnapshots:
                  - CacheSize: ''
                    CacheNodeId: '0001'
                    CacheNodeCreateTime: '2017-02-03T15:43:36.278Z'
                  CacheSubnetGroupName: default
                  Port: 6379
                  PreferredMaintenanceWindow: sat:08:00-sat:09:00
                  CacheNodeType: cache.m3.medium
        '404':
          description: CacheClusterNotFoundFault; ReplicationGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheClusterNotFoundFault'
        '400':
          description: InvalidCacheClusterStateFault; InvalidParameterCombinationException; InvalidParameterValueException; InvalidReplicationGroupStateFault; SnapshotAlreadyExistsFault; SnapshotFeatureNotSupportedFault; SnapshotQuotaExceededFault; TagQuotaPerResourceExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidCacheClusterStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateSnapshot
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/CreateSnapshotMessage'
            example:
              CacheClusterId: threenoderedis-001
              SnapshotName: snapshot-2
      tags:
      - Snapshot
  /?Action=DeleteSnapshot:
    post:
      operationId: DeleteSnapshot
      summary: Delete Snapshot
      description: Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Valkey or Redis OSS only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteSnapshotResult'
              example:
                Snapshot:
                  Engine: redis
                  CacheParameterGroupName: default.redis3.2
                  VpcId: vpc-91280df6
                  CacheClusterId: my-redis5
                  SnapshotRetentionLimit: 7
                  NumCacheNodes: 1
                  SnapshotName: snapshot-20161212
                  CacheClusterCreateTime: '2016-12-21T22:27:12.543Z'
                  AutoMinorVersionUpgrade: true
                  PreferredAvailabilityZone: us-east-1c
                  SnapshotStatus: deleting
                  SnapshotSource: manual
                  SnapshotWindow: 10:00-11:00
                  EngineVersion: 3.2.4
                  NodeSnapshots:
                  - CacheSize: 3 MB
                    SnapshotCreateTime: '2016-12-21T22:30:26Z'
                    CacheNodeId: '0001'
                    CacheNodeCreateTime: '2016-12-21T22:27:12.543Z'
                  CacheSubnetGroupName: default
                  Port: 6379
                  PreferredMaintenanceWindow: fri:05:30-fri:06:30
                  CacheNodeType: cache.m3.large
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidSnapshotStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: SnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/SnapshotNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteSnapshot
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DeleteSnapshotMessage'
            example:
              SnapshotName: snapshot-20161212
      tags:
      - Snapshot
  /?Action=DescribeSnapshots:
    post:
      operationId: DescribeSnapshots
      summary: Describe Snapshots
      description: Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Valkey or Redis OSS only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeSnapshotsListMessage'
              example:
                Marker: ''
                Snapshots:
                - Engine: redis
                  CacheParameterGroupName: default.redis3.2
                  VpcId: vpc-91280df6
                  CacheClusterId: my-redis5
                  SnapshotRetentionLimit: 7
                  NumCacheNodes: 1
                  SnapshotName: snapshot-20161212
                  CacheClusterCreateTime: '2016-12-21T22:27:12.543Z'
                  AutoMinorVersionUpgrade: true
                  PreferredAvailabilityZone: us-east-1c
                  SnapshotStatus: available
                  SnapshotSource: manual
                  SnapshotWindow: 10:00-11:00
                  EngineVersion: 3.2.4
                  NodeSnapshots:
                  - CacheSize: 3 MB
                    SnapshotCreateTime: '2016-12-21T22:30:26Z'
                    CacheNodeId: '0001'
                    CacheNodeCreateTime: '2016-12-21T22:27:12.543Z'
                  CacheSubnetGroupName: default
                  Port: 6379
                  PreferredMaintenanceWindow: fri:05:30-fri:06:30
                  CacheNodeType: cache.m3.large
        '404':
          description: CacheClusterNotFoundFault; SnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheClusterNotFoundFault'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeSnapshots
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DescribeSnapshotsMessage'
            example:
              SnapshotName: snapshot-20161212
      tags:
      - Snapshot
components:
  schemas:
    Snapshot:
      type: object
      properties:
        SnapshotName:
          type: string
          description: The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
        ReplicationGroupId:
          type: string
          description: The unique identifier of the source replication group.
        ReplicationGroupDescription:
          type: string
          description: A description of the source replication group.
        CacheClusterId:
          type: string
          description: The user-supplied identifier of the source cluster.
        SnapshotStatus:
          type: string
          description: 'The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.'
        SnapshotSource:
          type: string
          description: Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
        CacheNodeType:
          type: string
          description: 'The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS engine versio'
        Engine:
          type: string
          description: The name of the cache engine (memcached or redis) used by the source cluster.
        EngineVersion:
          type: string
          description: The version of the cache engine version that is used by the source cluster.
        NumCacheNodes:
          type: integer
          description: The number of cache nodes in the source cluster. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
        PreferredAvailabilityZone:
          type: string
          description: The name of the Availability Zone in which the source cluster is located.
        PreferredOutpostArn:
          type: string
          description: The ARN (Amazon Resource Name) of the preferred outpost.
        CacheClusterCreateTime:
          type: string
          format: date-time
          description: The date and time when the source cluster was created.
        PreferredMaintenanceWindow:
          type: string
          description: 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30'
        TopicArn:
          type: string
          description: The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
        Port:
          type: integer
          description: The port number used by each cache nodes in the source cluster.
        CacheParameterGroupName:
          type: string
          description: The cache parameter group that is associated with the source cluster.
        CacheSubnetGroupName:
          type: string
          description: The name of the cache subnet group associated with the source cluster.
        VpcId:
          type: string
          description: The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
        AutoMinorVersionUpgrade:
          type: boolean
          description: If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
        SnapshotRetentionLimit:
          type: integer
          description: 'For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.'
        SnapshotWindow:
          type: string
          description: The daily time range during which ElastiCache takes daily snapshots of the source cluster.
        NumNodeGroups:
          type: integer
          description: The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
        AutomaticFailover:
          type: string
          enum:
          - enabled
          - disabled
          - enabling
          - disabling
          description: Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
        NodeSnapshots:
          type: array
          items:
            $ref: '#/components/schemas/NodeSnapshot'
          description: A list of the cache nodes in the source cluster.
        KmsKeyId:
          type: string
          description: The ID of the KMS key used to encrypt the snapshot.
        ARN:
          type: string
          description: The ARN (Amazon Resource Name) of the snapshot.
        DataTiering:
          type: string
          enum:
          - enabled
          - disabled
          description: Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
        Durability:
          type: string
          enum:
          - default
          - async
          - sync
          - disabled
          description: The durability setting of the cluster when the snapshot was taken. When restoring from this snapshot, the cluster uses this durability setting unless overridden in the restore request. For more information, see Durability.
    NodeGroupConfiguration:
      type: object
      properties:
        NodeGroupId:
          type: string
          description: Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
        Slots:
          type: string
          description: 'A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey. Example: "0-3999"'
        ReplicaCount:
          type: integer
          description: The number of read replica nodes in this node group (shard).
        PrimaryAvailabilityZone:
          type: string
          description: The Availability Zone where the primary node of this node group (shard) is launched.
        ReplicaAvailabilityZones:
          type: array
          items:
            type: string
          description: A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
        PrimaryOutpostArn:
          type: string
          description: The outpost ARN of the primary node.
        ReplicaOutpostArns:
          type: array
          items:
            type: string
          description: The outpost ARN of the node replicas.
    NodeSnapshot:
      type: object
      properties:
        CacheClusterId:
          type: string
          description: A unique identifier for the source cluster.
        NodeGroupId:
          type: string
          description: A unique identifier for the source node group (shard).
        CacheNodeId:
          type: string
          description: The cache node identifier for the node in the source cluster.
        NodeGroupConfiguration:
          $ref: '#/components/schemas/NodeGroupConfiguration'
        CacheSize:
          type: string
          description: The size of the cache on the source cache node.
        CacheNodeCreateTime:
          type: string
          format: date-time
          description: The date and time when the cache node was created in the source cluster.
        SnapshotCreateTime:
          type: string
          format: date-time
          description: The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    DeleteSnapshotMessage:
      type: object
      properties:
        SnapshotName:
          type: string
          description: The name of the snapshot to be deleted.
      required:
      - SnapshotName
    CreateSnapshotResult:
      type: object
      properties:
        Snapshot:
          $ref: '#/components/schemas/Snapshot'
    SnapshotNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DescribeSnapshotsMessage:
      type: object
      properties:
        ReplicationGroupId:
          type: string
          description: A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
        CacheClusterId:
          type: string
          description: A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
        SnapshotName:
          type: string
          description: A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
        SnapshotSource:
          type: string
          description: If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
        Marker:
          type: string
          description: An optional marker returned from a prior request. Use this marker for 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 MaxRecords.
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.'
        ShowNodeGroupConfig:
          type: boolean
          description: A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
    DescribeSnapshotsListMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional marker returned from a prior request. Use this marker for 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 MaxRecords.
        Snapshots:
          type: array
          items:
            $ref: '#/components/schemas/Snapshot'
          description: A list of snapshots. Each item in the list contains detailed information about one snapshot.
    DeleteSnapshotResult:
      type: object
      properties:
        Snapshot:
          $ref: '#/components/schemas/Snapshot'
    CacheClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
          description: Two or more parameters that must not be used together were used together.
    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.
    InvalidCacheClusterStateFault:
      type: object
      properties:
        message:
          type: string
    CreateSnapshotMessage:
      type: object
      properties:
        ReplicationGroupId:
          type: string
          description: The identifier of an existing replication group. The snapshot is created from this replication group.
        CacheClusterId:
          type: string
          description: The identifier of an existing cluster. The snapshot is created from this cluster.
        SnapshotName:
          type: string
          description: A name for the snapshot being created. This value is stored as a lowercase string.
        KmsKeyId:
          type: string
          description: The ID of the KMS key used to encrypt the snapshot.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
      required:
      - SnapshotName
  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)