Amazon RDS Rds Global Cluster API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Global Cluster API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Global Cluster
paths:
  /?Action=CreateGlobalCluster:
    post:
      operationId: CreateGlobalCluster
      summary: Create Global Cluster
      description: Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This operation applies only to Aurora DB clusters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateGlobalClusterResult'
              example:
                GlobalCluster:
                  GlobalClusterIdentifier: myglobalcluster
                  GlobalClusterResourceId: cluster-f0e523bfe07aabb
                  GlobalClusterArn: arn:aws:rds::123456789012:global-cluster:myglobalcluster
                  Status: available
                  Engine: aurora-mysql
                  EngineVersion: 5.7.mysql_aurora.2.07.2
                  StorageEncrypted: false
                  DeletionProtection: false
                  GlobalClusterMembers: []
        '404':
          description: DBClusterNotFoundFault; ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: GlobalClusterAlreadyExistsFault; GlobalClusterQuotaExceededFault; InvalidDBClusterStateFault; InvalidDBShardGroupStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalClusterAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateGlobalCluster
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateGlobalClusterMessage'
            example:
              GlobalClusterIdentifier: myglobalcluster
              Engine: aurora-mysql
      tags:
      - Global Cluster
  /?Action=DeleteGlobalCluster:
    post:
      operationId: DeleteGlobalCluster
      summary: Delete Global Cluster
      description: Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteGlobalClusterResult'
              example:
                GlobalCluster:
                  GlobalClusterIdentifier: myglobalcluster
                  GlobalClusterResourceId: cluster-f0e523bfe07aabb
                  GlobalClusterArn: arn:aws:rds::123456789012:global-cluster:myglobalcluster
                  Status: available
                  Engine: aurora-mysql
                  EngineVersion: 5.7.mysql_aurora.2.07.2
                  StorageEncrypted: false
                  DeletionProtection: false
                  GlobalClusterMembers: []
        '404':
          description: GlobalClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalClusterNotFoundFault'
        '400':
          description: InvalidGlobalClusterStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidGlobalClusterStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteGlobalCluster
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteGlobalClusterMessage'
            example:
              GlobalClusterIdentifier: myglobalcluster
      tags:
      - Global Cluster
  /?Action=DescribeGlobalClusters:
    post:
      operationId: DescribeGlobalClusters
      summary: Describe Global Clusters
      description: Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalClustersMessage'
              example:
                GlobalClusters:
                - GlobalClusterIdentifier: myglobalcluster
                  GlobalClusterResourceId: cluster-f5982077e3b5aabb
                  GlobalClusterArn: arn:aws:rds::123456789012:global-cluster:myglobalcluster
                  Status: available
                  Engine: aurora-mysql
                  EngineVersion: 5.7.mysql_aurora.2.07.2
                  StorageEncrypted: false
                  DeletionProtection: false
                  GlobalClusterMembers: []
        '404':
          description: GlobalClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeGlobalClusters
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeGlobalClustersMessage'
      tags:
      - Global Cluster
  /?Action=ModifyGlobalCluster:
    post:
      operationId: ModifyGlobalCluster
      summary: Modify Global Cluster
      description: Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This operation only applies to Aurora global database clusters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyGlobalClusterResult'
              example:
                GlobalCluster:
                  GlobalClusterIdentifier: myglobalcluster
                  GlobalClusterResourceId: cluster-f0e523bfe07aabb
                  GlobalClusterArn: arn:aws:rds::123456789012:global-cluster:myglobalcluster
                  Status: available
                  Engine: aurora-mysql
                  EngineVersion: 5.7.mysql_aurora.2.07.2
                  StorageEncrypted: false
                  DeletionProtection: true
                  GlobalClusterMembers: []
        '400':
          description: GlobalClusterAlreadyExistsFault; InvalidDBClusterStateFault; InvalidDBInstanceStateFault; InvalidGlobalClusterStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalClusterAlreadyExistsFault'
        '404':
          description: GlobalClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyGlobalCluster
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyGlobalClusterMessage'
            example:
              GlobalClusterIdentifier: myglobalcluster
              DeletionProtection: true
      tags:
      - Global Cluster
components:
  schemas:
    GlobalCluster:
      type: object
      properties:
        GlobalClusterIdentifier:
          type: string
          description: Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
        GlobalClusterResourceId:
          type: string
          description: The Amazon Web Services partition-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
        GlobalClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) for the global database cluster.
        Status:
          type: string
          description: Specifies the current state of this global database cluster.
        Engine:
          type: string
          description: The Aurora database engine used by the global database cluster.
        EngineVersion:
          type: string
          description: Indicates the database engine version.
        EngineLifecycleSupport:
          type: string
          description: The lifecycle type for the global cluster. For more information, see CreateGlobalCluster.
        DatabaseName:
          type: string
          description: The default database name within the new global database cluster.
        StorageEncrypted:
          type: boolean
          description: The storage encryption setting for the global database cluster.
        StorageEncryptionType:
          type: string
          enum:
          - none
          - sse-kms
          - sse-rds
          description: 'The type of encryption used to protect data at rest in the global database cluster. Possible values: none - The global database cluster is not encrypted. sse-rds - The global database cluster is encrypted using an Amazon Web Services owned KMS key. sse-kms - The global database cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.'
        DeletionProtection:
          type: boolean
          description: The deletion protection setting for the new global database cluster.
        GlobalClusterMembers:
          type: array
          items:
            $ref: '#/components/schemas/GlobalClusterMember'
          description: The list of primary and secondary clusters within the global database cluster.
        Endpoint:
          type: string
          description: The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
        FailoverState:
          $ref: '#/components/schemas/FailoverState'
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    ModifyGlobalClusterResult:
      type: object
      properties:
        GlobalCluster:
          $ref: '#/components/schemas/GlobalCluster'
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    GlobalClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    GlobalClustersMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        GlobalClusters:
          type: array
          items:
            $ref: '#/components/schemas/GlobalCluster'
          description: The list of global clusters returned by this request.
    GlobalClusterMember:
      type: object
      properties:
        DBClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
        Readers:
          type: array
          items:
            type: string
          description: The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
        IsWriter:
          type: boolean
          description: Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
        GlobalWriteForwardingStatus:
          type: string
          enum:
          - enabled
          - disabled
          - enabling
          - disabling
          - unknown
          description: The status of write forwarding for a secondary cluster in the global cluster.
        SynchronizationStatus:
          type: string
          enum:
          - connected
          - pending-resync
          description: The status of synchronization of each Aurora DB cluster in the global cluster.
    CreateGlobalClusterMessage:
      type: object
      properties:
        GlobalClusterIdentifier:
          type: string
          description: The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
        SourceDBClusterIdentifier:
          type: string
          description: 'The Amazon Resource Name (ARN) to use as the primary cluster of the global database. If you provide a value for this parameter, don''t specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster: DatabaseName Engine EngineVersion StorageEncrypted'
        Engine:
          type: string
          description: 'The database engine to use for this global database cluster. Valid Values: aurora-mysql | aurora-postgresql Constraints: Can''t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.'
        EngineVersion:
          type: string
          description: 'The engine version to use for this global database cluster. Constraints: Can''t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.'
        EngineLifecycleSupport:
          type: string
          description: The lifecycle type for this global database cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended S
        DeletionProtection:
          type: boolean
          description: Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.
        DatabaseName:
          type: string
          description: 'The name for your database of up to 64 alphanumeric characters. If you don''t specify a name, Amazon Aurora doesn''t create a database in the global database cluster. Constraints: Can''t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.'
        StorageEncrypted:
          type: boolean
          description: 'Specifies whether to enable storage encryption for the new global database cluster. Constraints: Can''t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to assign to the global cluster.
      required:
      - GlobalClusterIdentifier
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can''t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
        Value:
          type: string
          description: 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can''t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
    DescribeGlobalClustersMessage:
      type: object
      properties:
        GlobalClusterIdentifier:
          type: string
          description: 'The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn''t case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier.'
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive. Currently, the only supported filter is region. If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    DeleteGlobalClusterMessage:
      type: object
      properties:
        GlobalClusterIdentifier:
          type: string
          description: The cluster identifier of the global database cluster being deleted.
      required:
      - GlobalClusterIdentifier
    CreateGlobalClusterResult:
      type: object
      properties:
        GlobalCluster:
          $ref: '#/components/schemas/GlobalCluster'
    ModifyGlobalClusterMessage:
      type: object
      properties:
        GlobalClusterIdentifier:
          type: string
          description: 'The cluster identifier for the global cluster to modify. This parameter isn''t case-sensitive. Constraints: Must match the identifier of an existing global database cluster.'
        NewGlobalClusterIdentifier:
          type: string
          description: 'The new cluster identifier for the global database cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Can''t end with a hyphen or contain two consecutive hyphens. Example: my-cluster2'
        DeletionProtection:
          type: boolean
          description: Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.
        EngineVersion:
          type: string
          description: 'The version number of the database engine to which you want to upgrade. To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query ''*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'' To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query ''*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'''
        AllowMajorVersionUpgrade:
          type: boolean
          description: 'Specifies whether to allow major version upgrades. Constraints: Must be enabled if you specify a value for the EngineVersion parameter that''s a different major version than the global cluster''s current version. If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.'
      required:
      - GlobalClusterIdentifier
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case-sensitive.
      required:
      - Name
      - Values
    InvalidGlobalClusterStateFault:
      type: object
      properties:
        message:
          type: string
    GlobalClusterAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    FailoverState:
      type: object
      properties:
        Status:
          type: string
          enum:
          - pending
          - failing-over
          - cancelling
          description: 'The current status of the global cluster. Possible values are as follows: pending – The service received a request to switch over or fail over the global cluster. The global cluster''s primary DB cluster and the specified secondary DB cluster are being verified before the operation starts. failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster. cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Auro'
        FromDbClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
        ToDbClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
        IsDataLossAllowed:
          type: boolean
          description: Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
    DeleteGlobalClusterResult:
      type: object
      properties:
        GlobalCluster:
          $ref: '#/components/schemas/GlobalCluster'
  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: rds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rds/service/2014-10-31/rds-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)