Amazon ElastiCache Elasticache Global Replication Group API

openapi: 3.2.0
info:
  title: Amazon ElastiCache Global Replication Group API
  version: '2015-02-02'
  description: Generated from AWS's published Smithy model for Amazon ElastiCache. 5 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: Global Replication Group
paths:
  /?Action=CreateGlobalReplicationGroup:
    post:
      operationId: CreateGlobalReplicationGroup
      summary: Create Global Replication Group
      description: Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore. The GlobalReplicationGroupIdSuffix is the name of the Global datastore. The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateGlobalReplicationGroupResult'
        '400':
          description: GlobalReplicationGroupAlreadyExistsFault; InvalidParameterValueException; InvalidReplicationGroupStateFault; ServiceLinkedRoleNotFoundFault; TagQuotaPerResourceExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalReplicationGroupAlreadyExistsFault'
        '404':
          description: ReplicationGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReplicationGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateGlobalReplicationGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/CreateGlobalReplicationGroupMessage'
      tags:
      - Global Replication Group
  /?Action=DeleteGlobalReplicationGroup:
    post:
      operationId: DeleteGlobalReplicationGroup
      summary: Delete Global Replication Group
      description: 'Deleting a Global datastore is a two-step process: First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore. Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true. Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteGlobalReplicationGroupResult'
        '404':
          description: GlobalReplicationGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalReplicationGroupNotFoundFault'
        '400':
          description: InvalidGlobalReplicationGroupStateFault; InvalidParameterValueException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidGlobalReplicationGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteGlobalReplicationGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DeleteGlobalReplicationGroupMessage'
      tags:
      - Global Replication Group
  /?Action=DescribeGlobalReplicationGroups:
    post:
      operationId: DescribeGlobalReplicationGroups
      summary: Describe Global Replication Groups
      description: Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeGlobalReplicationGroupsResult'
        '404':
          description: GlobalReplicationGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalReplicationGroupNotFoundFault'
        '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: DescribeGlobalReplicationGroups
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DescribeGlobalReplicationGroupsMessage'
      tags:
      - Global Replication Group
  /?Action=DisassociateGlobalReplicationGroup:
    post:
      operationId: DisassociateGlobalReplicationGroup
      summary: Disassociate Global Replication Group
      description: Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisassociateGlobalReplicationGroupResult'
        '404':
          description: GlobalReplicationGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalReplicationGroupNotFoundFault'
        '400':
          description: InvalidGlobalReplicationGroupStateFault; InvalidParameterCombinationException; InvalidParameterValueException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidGlobalReplicationGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisassociateGlobalReplicationGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DisassociateGlobalReplicationGroupMessage'
      tags:
      - Global Replication Group
  /?Action=ModifyGlobalReplicationGroup:
    post:
      operationId: ModifyGlobalReplicationGroup
      summary: Modify Global Replication Group
      description: Modifies the settings for a Global datastore.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyGlobalReplicationGroupResult'
        '404':
          description: GlobalReplicationGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalReplicationGroupNotFoundFault'
        '400':
          description: InvalidGlobalReplicationGroupStateFault; InvalidParameterValueException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidGlobalReplicationGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyGlobalReplicationGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/ModifyGlobalReplicationGroupMessage'
      tags:
      - Global Replication Group
components:
  schemas:
    DisassociateGlobalReplicationGroupResult:
      type: object
      properties:
        GlobalReplicationGroup:
          $ref: '#/components/schemas/GlobalReplicationGroup'
    ReplicationGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DisassociateGlobalReplicationGroupMessage:
      type: object
      properties:
        GlobalReplicationGroupId:
          type: string
          description: The name of the Global datastore
        ReplicationGroupId:
          type: string
          description: The name of the secondary cluster you wish to remove from the Global datastore
        ReplicationGroupRegion:
          type: string
          description: The Amazon region of secondary cluster you wish to remove from the Global datastore
      required:
      - GlobalReplicationGroupId
      - ReplicationGroupId
      - ReplicationGroupRegion
    InvalidGlobalReplicationGroupStateFault:
      type: object
      properties:
        message:
          type: string
    GlobalReplicationGroupMember:
      type: object
      properties:
        ReplicationGroupId:
          type: string
          description: The replication group id of the Global datastore member.
        ReplicationGroupRegion:
          type: string
          description: The Amazon region of the Global datastore member.
        Role:
          type: string
          description: Indicates the role of the replication group, primary or secondary.
        AutomaticFailover:
          type: string
          enum:
          - enabled
          - disabled
          - enabling
          - disabling
          description: Indicates whether automatic failover is enabled for the replication group.
        Status:
          type: string
          description: The status of the membership of the replication group.
    DeleteGlobalReplicationGroupResult:
      type: object
      properties:
        GlobalReplicationGroup:
          $ref: '#/components/schemas/GlobalReplicationGroup'
    CreateGlobalReplicationGroupMessage:
      type: object
      properties:
        GlobalReplicationGroupIdSuffix:
          type: string
          description: The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions. For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
        GlobalReplicationGroupDescription:
          type: string
          description: Provides details of the Global datastore
        PrimaryReplicationGroupId:
          type: string
          description: The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster. This value is stored as a lowercase string.
        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:
      - GlobalReplicationGroupIdSuffix
      - PrimaryReplicationGroupId
    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.
    ModifyGlobalReplicationGroupResult:
      type: object
      properties:
        GlobalReplicationGroup:
          $ref: '#/components/schemas/GlobalReplicationGroup'
    GlobalReplicationGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    GlobalNodeGroup:
      type: object
      properties:
        GlobalNodeGroupId:
          type: string
          description: The name of the global node group
        Slots:
          type: string
          description: The keyspace for this node group
    CreateGlobalReplicationGroupResult:
      type: object
      properties:
        GlobalReplicationGroup:
          $ref: '#/components/schemas/GlobalReplicationGroup'
    GlobalReplicationGroup:
      type: object
      properties:
        GlobalReplicationGroupId:
          type: string
          description: The name of the Global datastore
        GlobalReplicationGroupDescription:
          type: string
          description: The optional description of the Global datastore
        Status:
          type: string
          description: The status of the Global datastore
        CacheNodeType:
          type: string
          description: The cache node type of the Global datastore
        Engine:
          type: string
          description: The ElastiCache engine. For Valkey or Redis OSS only.
        EngineVersion:
          type: string
          description: The ElastiCache engine version.
        Members:
          type: array
          items:
            $ref: '#/components/schemas/GlobalReplicationGroupMember'
          description: The replication groups that comprise the Global datastore.
        ClusterEnabled:
          type: boolean
          description: A flag that indicates whether the Global datastore is cluster enabled.
        GlobalNodeGroups:
          type: array
          items:
            $ref: '#/components/schemas/GlobalNodeGroup'
          description: Indicates the slot configuration and global identifier for each slice group.
        AuthTokenEnabled:
          type: boolean
          description: 'A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands. Default: false'
        TransitEncryptionEnabled:
          type: boolean
          description: 'A flag that enables in-transit encryption when set to true. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.'
        AtRestEncryptionEnabled:
          type: boolean
          description: 'A flag that enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.'
        ARN:
          type: string
          description: The ARN (Amazon Resource Name) of the global replication group.
    DescribeGlobalReplicationGroupsResult:
      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. >
        GlobalReplicationGroups:
          type: array
          items:
            $ref: '#/components/schemas/GlobalReplicationGroup'
          description: Indicates the slot configuration and global identifier for each slice group.
    DeleteGlobalReplicationGroupMessage:
      type: object
      properties:
        GlobalReplicationGroupId:
          type: string
          description: The name of the Global datastore
        RetainPrimaryReplicationGroup:
          type: boolean
          description: The primary replication group is retained as a standalone replication group.
      required:
      - GlobalReplicationGroupId
      - RetainPrimaryReplicationGroup
    GlobalReplicationGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DescribeGlobalReplicationGroupsMessage:
      type: object
      properties:
        GlobalReplicationGroupId:
          type: string
          description: The name of the Global datastore
        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.
        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.
        ShowMemberInfo:
          type: boolean
          description: Returns the list of members that comprise the Global datastore.
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
          description: Two or more parameters that must not be used together were used together.
    ModifyGlobalReplicationGroupMessage:
      type: object
      properties:
        GlobalReplicationGroupId:
          type: string
          description: The name of the Global datastore
        ApplyImmediately:
          type: boolean
          description: This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.
        CacheNodeType:
          type: string
          description: A valid cache node type that you want to scale this Global datastore to.
        Engine:
          type: string
          description: Modifies the engine listed in a global replication group message. The options are valkey, memcached or redis.
        EngineVersion:
          type: string
          description: The upgraded version of the cache engine to be run on the clusters in the Global datastore.
        CacheParameterGroupName:
          type: string
          description: The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
        GlobalReplicationGroupDescription:
          type: string
          description: A description of the Global datastore
        AutomaticFailoverEnabled:
          type: boolean
          description: Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
      required:
      - GlobalReplicationGroupId
      - ApplyImmediately
  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)