Amazon MemoryDB

Amazon MemoryDB Memorydb Multi Region Cluster API

The Memorydb Multi Region Cluster API from Amazon MemoryDB — 4 operation(s) for memorydb multi region cluster.

GitHub OpenAPI

Operations 4

POST /#CreateMultiRegionCluster Create Multi Region Cluster #
POST /#DeleteMultiRegionCluster Delete Multi Region Cluster #
POST /#DescribeMultiRegionClusters Describe Multi Region Clusters #
POST /#UpdateMultiRegionCluster Update Multi Region Cluster #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-memorydb/openapi/amazon-memorydb-multi-region-cluster-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-memorydb:amazon-memorydb-multi-region-cluster-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-memorydb-multi-region-cluster-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon MemoryDB Multi Region Cluster API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon MemoryDB. 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://memory-db.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateMultiRegionCluster:
    post:
      operationId: CreateMultiRegionCluster
      summary: Create Multi Region Cluster
      description: Creates a new multi-Region cluster.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateMultiRegionClusterResponse'
        '400':
          description: ClusterQuotaForCustomerExceededFault; InvalidParameterCombinationException; InvalidParameterValueException;
            MultiRegionClusterAlreadyExistsFault; TagQuotaPerResourceExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterQuotaForCustomerExceededFault'
        '404':
          description: MultiRegionParameterGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/MultiRegionParameterGroupNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.CreateMultiRegionCluster
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateMultiRegionClusterRequest'
      tags:
      - Multi Region Cluster
  /#DeleteMultiRegionCluster:
    post:
      operationId: DeleteMultiRegionCluster
      summary: Delete Multi Region Cluster
      description: Deletes an existing multi-Region cluster.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteMultiRegionClusterResponse'
        '400':
          description: InvalidMultiRegionClusterStateFault; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidMultiRegionClusterStateFault'
        '404':
          description: MultiRegionClusterNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/MultiRegionClusterNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DeleteMultiRegionCluster
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteMultiRegionClusterRequest'
      tags:
      - Multi Region Cluster
  /#DescribeMultiRegionClusters:
    post:
      operationId: DescribeMultiRegionClusters
      summary: Describe Multi Region Clusters
      description: Returns details about one or more multi-Region clusters.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMultiRegionClustersResponse'
        '404':
          description: ClusterNotFoundFault; MultiRegionClusterNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DescribeMultiRegionClusters
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMultiRegionClustersRequest'
      tags:
      - Multi Region Cluster
  /#UpdateMultiRegionCluster:
    post:
      operationId: UpdateMultiRegionCluster
      summary: Update Multi Region Cluster
      description: Updates the configuration of an existing multi-Region cluster.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateMultiRegionClusterResponse'
        '400':
          description: InvalidMultiRegionClusterStateFault; InvalidParameterCombinationException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidMultiRegionClusterStateFault'
        '404':
          description: MultiRegionClusterNotFoundFault; MultiRegionParameterGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/MultiRegionClusterNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.UpdateMultiRegionCluster
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateMultiRegionClusterRequest'
      tags:
      - Multi Region Cluster
components:
  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: memorydb
  schemas:
    ClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ClusterQuotaForCustomerExceededFault:
      type: object
      properties:
        message:
          type: string
    CreateMultiRegionClusterRequest:
      type: object
      properties:
        MultiRegionClusterNameSuffix:
          type: string
          description: A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix
            to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region
            cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide.
            The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.
        Description:
          type: string
          description: A description for the multi-Region cluster.
        Engine:
          type: string
          description: The name of the engine to be used for the multi-Region cluster.
        EngineVersion:
          type: string
          description: The version of the engine to be used for the multi-Region cluster.
        NodeType:
          type: string
          description: The node type to be used for the multi-Region cluster.
        MultiRegionParameterGroupName:
          type: string
          description: The name of the multi-Region parameter group to be associated with the cluster.
        NumShards:
          type: integer
          description: The number of shards for the multi-Region cluster.
        TLSEnabled:
          type: boolean
          description: Whether to enable TLS encryption for the multi-Region cluster.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to be applied to the multi-Region cluster.
      required:
      - MultiRegionClusterNameSuffix
      - NodeType
    CreateMultiRegionClusterResponse:
      type: object
      properties:
        MultiRegionCluster:
          $ref: '#/components/schemas/MultiRegionCluster'
    DeleteMultiRegionClusterRequest:
      type: object
      properties:
        MultiRegionClusterName:
          type: string
          description: The name of the multi-Region cluster to be deleted.
      required:
      - MultiRegionClusterName
    DeleteMultiRegionClusterResponse:
      type: object
      properties:
        MultiRegionCluster:
          $ref: '#/components/schemas/MultiRegionCluster'
    DescribeMultiRegionClustersRequest:
      type: object
      properties:
        MultiRegionClusterName:
          type: string
          description: The name of a specific multi-Region cluster to describe.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
        NextToken:
          type: string
          description: A token to specify where to start paginating.
        ShowClusterDetails:
          type: boolean
          description: Details about the multi-Region cluster.
    DescribeMultiRegionClustersResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: A token to use to retrieve the next page of results.
        MultiRegionClusters:
          type: array
          items:
            $ref: '#/components/schemas/MultiRegionCluster'
          description: A list of multi-Region clusters.
    InvalidMultiRegionClusterStateFault:
      type: object
      properties:
        message:
          type: string
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
    MultiRegionCluster:
      type: object
      properties:
        MultiRegionClusterName:
          type: string
          description: The name of the multi-Region cluster.
        Description:
          type: string
          description: The description of the multi-Region cluster.
        Status:
          type: string
          description: The current status of the multi-Region cluster.
        NodeType:
          type: string
          description: The node type used by the multi-Region cluster.
        Engine:
          type: string
          description: The name of the engine used by the multi-Region cluster.
        EngineVersion:
          type: string
          description: The version of the engine used by the multi-Region cluster.
        NumberOfShards:
          type: integer
          description: The number of shards in the multi-Region cluster.
        Clusters:
          type: array
          items:
            $ref: '#/components/schemas/RegionalCluster'
          description: The clusters in this multi-Region cluster.
        MultiRegionParameterGroupName:
          type: string
          description: The name of the multi-Region parameter group associated with the cluster.
        TLSEnabled:
          type: boolean
          description: Indiciates if the multi-Region cluster is TLS enabled.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of the multi-Region cluster.
    MultiRegionClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    MultiRegionParameterGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    RegionalCluster:
      type: object
      properties:
        ClusterName:
          type: string
          description: The name of the Regional cluster
        Region:
          type: string
          description: The Region the current Regional cluster is assigned to.
        Status:
          type: string
          description: The status of the Regional cluster.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) the Regional cluster
    ShardConfigurationRequest:
      type: object
      properties:
        ShardCount:
          type: integer
          description: The number of shards in the cluster
    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.
    UpdateMultiRegionClusterRequest:
      type: object
      properties:
        MultiRegionClusterName:
          type: string
          description: The name of the multi-Region cluster to be updated.
        NodeType:
          type: string
          description: The new node type to be used for the multi-Region cluster.
        Description:
          type: string
          description: A new description for the multi-Region cluster.
        EngineVersion:
          type: string
          description: The new engine version to be used for the multi-Region cluster.
        ShardConfiguration:
          $ref: '#/components/schemas/ShardConfigurationRequest'
        MultiRegionParameterGroupName:
          type: string
          description: The new multi-Region parameter group to be associated with the cluster.
        UpdateStrategy:
          type: string
          enum:
          - coordinated
          - uncoordinated
          description: The strategy to use for the update operation. Supported values are "coordinated" or "uncoordinated".
      required:
      - MultiRegionClusterName
    UpdateMultiRegionClusterResponse:
      type: object
      properties:
        MultiRegionCluster:
          $ref: '#/components/schemas/MultiRegionCluster'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/memorydb/service/2021-01-01/memorydb-2021-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)