Amazon Neptune DB Clusters API

openapi: 3.1.0
info:
  title: Amazon Neptune Neptune Analytics ?Action=AddTagsToResource ?Action=AddTagsToResource DB Clusters API
  description: Neptune Analytics is a memory-optimized graph database engine for analytics, providing optimized graph analytic algorithms, low-latency queries, and vector search capabilities within graph traversals. This API provides management operations for Neptune Analytics graph resources including creating, managing, and querying graph databases optimized for analytical workloads.
  version: '2023-11-29'
  contact:
    name: Amazon Web Services
    url: https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://neptune-graph.{region}.amazonaws.com
  description: Neptune Analytics control plane regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- aws_sigv4: []
tags:
- name: DB Clusters
  description: Operations for managing Neptune DB clusters
paths:
  /:
    get:
      operationId: describeDBClusters
      summary: Amazon Neptune Describe Neptune DB Clusters
      description: Returns information about provisioned Neptune DB clusters. If a cluster identifier is supplied, details for that specific cluster are returned. Otherwise, details for up to 100 clusters are returned.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeDBClusters
      - name: DBClusterIdentifier
        in: query
        description: The identifier of the DB cluster to describe.
        schema:
          type: string
      - name: MaxRecords
        in: query
        description: Maximum number of records to include in the response (20-100).
        schema:
          type: integer
          minimum: 20
          maximum: 100
      - name: Marker
        in: query
        description: Pagination token from a previous request.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: Successful response with DB cluster details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DescribeDBClustersResponse'
              examples:
                describeDBClusters200Example:
                  summary: Default describeDBClusters 200 response
                  x-microcks-default: true
                  value:
                    DBClusters:
                    - {}
                    Marker: example-value
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDBCluster
      summary: Amazon Neptune Create a New Neptune DB Cluster
      description: Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CreateDBCluster
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateDBClusterRequest'
      responses:
        '200':
          description: DB cluster created successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                createDBCluster200Example:
                  summary: Default createDBCluster 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '400':
          description: Invalid request parameters.
        '409':
          description: A DB cluster with the specified identifier already exists.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DeleteDBCluster:
    post:
      operationId: deleteDBCluster
      summary: Amazon Neptune Delete a Neptune DB Cluster
      description: Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups are deleted and cannot be recovered. Manual snapshots are not deleted.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DeleteDBCluster
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The DB cluster identifier for the cluster to be deleted.
        schema:
          type: string
      - name: SkipFinalSnapshot
        in: query
        description: Whether to skip creation of a final snapshot before deletion.
        schema:
          type: boolean
      - name: FinalDBSnapshotIdentifier
        in: query
        description: The identifier of the final snapshot to create before deletion.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: DB cluster deleted successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                deleteDBCluster200Example:
                  summary: Default deleteDBCluster 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=ModifyDBCluster:
    post:
      operationId: modifyDBCluster
      summary: Amazon Neptune Modify a Neptune DB Cluster
      description: Modifies settings for a DB cluster. You can change one or more database configuration parameters by specifying them and their new values.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - ModifyDBCluster
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ModifyDBClusterRequest'
      responses:
        '200':
          description: DB cluster modified successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                modifyDBCluster200Example:
                  summary: Default modifyDBCluster 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=StartDBCluster:
    post:
      operationId: startDBCluster
      summary: Amazon Neptune Start a Stopped Neptune DB Cluster
      description: Starts a stopped Neptune DB cluster. When you start a cluster, Neptune restores the cluster to the state it was in when it was stopped.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - StartDBCluster
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The identifier of the DB cluster to start.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: DB cluster start initiated successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                startDBCluster200Example:
                  summary: Default startDBCluster 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=StopDBCluster:
    post:
      operationId: stopDBCluster
      summary: Amazon Neptune Stop a Running Neptune DB Cluster
      description: Stops a running Neptune DB cluster. While the cluster is stopped, you are charged only for storage. A stopped cluster automatically restarts after 7 days.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - StopDBCluster
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The identifier of the DB cluster to stop.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: DB cluster stop initiated successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                stopDBCluster200Example:
                  summary: Default stopDBCluster 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=FailoverDBCluster:
    post:
      operationId: failoverDBCluster
      summary: Amazon Neptune Force a Failover for a Neptune DB Cluster
      description: Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the read replicas in the cluster to be the new primary instance.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - FailoverDBCluster
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The identifier of the cluster to force a failover for.
        schema:
          type: string
      - name: TargetDBInstanceIdentifier
        in: query
        description: The name of the instance to promote to the primary instance.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: Failover initiated successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                failoverDBCluster200Example:
                  summary: Default failoverDBCluster 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=AddRoleToDBCluster:
    post:
      operationId: addRoleToDBCluster
      summary: Amazon Neptune Associate an IAM Role with a Neptune DB Cluster
      description: Associates an Identity and Access Management (IAM) role with a Neptune DB cluster so that the cluster can access other AWS services on your behalf.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - AddRoleToDBCluster
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The name of the DB cluster to associate the IAM role with.
        schema:
          type: string
      - name: RoleArn
        in: query
        required: true
        description: The ARN of the IAM role to associate with the cluster.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: IAM role associated successfully.
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=RemoveRoleFromDBCluster:
    post:
      operationId: removeRoleFromDBCluster
      summary: Amazon Neptune Disassociate an IAM Role from a Neptune DB Cluster
      description: Disassociates an Identity and Access Management (IAM) role from a Neptune DB cluster.
      tags:
      - DB Clusters
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - RemoveRoleFromDBCluster
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The name of the DB cluster to disassociate the role from.
        schema:
          type: string
      - name: RoleArn
        in: query
        required: true
        description: The ARN of the IAM role to disassociate.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: IAM role disassociated successfully.
        '404':
          description: The specified DB cluster or role was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ModifyDBClusterRequest:
      type: object
      required:
      - DBClusterIdentifier
      properties:
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier.
        NewDBClusterIdentifier:
          type: string
          description: The new cluster identifier when renaming.
        EngineVersion:
          type: string
          description: The version of the Neptune engine to upgrade to.
        Port:
          type: integer
          description: The port number on which the cluster accepts connections.
        DBClusterParameterGroupName:
          type: string
          description: The name of the cluster parameter group to use.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
        BackupRetentionPeriod:
          type: integer
        PreferredBackupWindow:
          type: string
        PreferredMaintenanceWindow:
          type: string
        DeletionProtection:
          type: boolean
        ApplyImmediately:
          type: boolean
          description: Whether to apply changes immediately or during the next maintenance window.
    CreateDBClusterRequest:
      type: object
      required:
      - DBClusterIdentifier
      - Engine
      properties:
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier.
        Engine:
          type: string
          description: The database engine to use (neptune).
          default: neptune
        EngineVersion:
          type: string
          description: The version of the Neptune engine.
        Port:
          type: integer
          description: The port number on which the cluster accepts connections.
          default: 8182
        DBSubnetGroupName:
          type: string
          description: The name of a DB subnet group.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of VPC security group IDs.
        StorageEncrypted:
          type: boolean
          description: Whether the cluster is encrypted.
        KmsKeyId:
          type: string
          description: The KMS key identifier for an encrypted cluster.
        PreferredBackupWindow:
          type: string
          description: The daily time range for automated backups (UTC).
        PreferredMaintenanceWindow:
          type: string
          description: The weekly time range for maintenance (UTC).
        BackupRetentionPeriod:
          type: integer
          description: The number of days for which automated backups are retained (1-35).
        DeletionProtection:
          type: boolean
          description: Whether to enable deletion protection.
        IAMDatabaseAuthenticationEnabled:
          type: boolean
          description: Whether to enable IAM database authentication.
    DBClusterMember:
      type: object
      description: A member instance of a Neptune DB cluster.
      properties:
        DBInstanceIdentifier:
          type: string
          description: The instance identifier.
        IsClusterWriter:
          type: boolean
          description: Whether the instance is the primary (writer) instance.
        DBClusterParameterGroupStatus:
          type: string
          description: The status of the parameter group for this member.
        PromotionTier:
          type: integer
          description: Failover priority for the instance.
    DBCluster:
      type: object
      description: Contains the details of an Amazon Neptune DB cluster.
      properties:
        DBClusterIdentifier:
          type: string
          description: The user-supplied DB cluster identifier.
        DBClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB cluster.
        Status:
          type: string
          description: Current state of the cluster.
        Engine:
          type: string
          description: The database engine (neptune).
        EngineVersion:
          type: string
          description: The version of the database engine.
        Endpoint:
          type: string
          description: The connection endpoint for the primary instance.
        ReaderEndpoint:
          type: string
          description: The reader endpoint for read replicas.
        Port:
          type: integer
          description: The port that the DB cluster listens on.
        MasterUsername:
          type: string
          description: The master username for the cluster.
        DBClusterParameterGroup:
          type: string
          description: The name of the DB cluster parameter group.
        DBSubnetGroup:
          type: string
          description: The DB subnet group associated with the cluster.
        AllocatedStorage:
          type: integer
          description: The allocated storage size in gigabytes.
        ClusterCreateTime:
          type: string
          format: date-time
          description: The time when the DB cluster was created.
        PreferredBackupWindow:
          type: string
          description: The daily time range for automated backups.
        PreferredMaintenanceWindow:
          type: string
          description: The weekly time range for system maintenance.
        MultiAZ:
          type: boolean
          description: Whether the cluster is Multi-AZ enabled.
        StorageEncrypted:
          type: boolean
          description: Whether the cluster storage is encrypted.
        KmsKeyId:
          type: string
          description: The KMS key identifier for encrypted clusters.
        DeletionProtection:
          type: boolean
          description: Whether deletion protection is enabled.
        IAMDatabaseAuthenticationEnabled:
          type: boolean
          description: Whether IAM database authentication is enabled.
        DBClusterMembers:
          type: array
          description: The list of instances in the cluster.
          items:
            $ref: '#/components/schemas/DBClusterMember'
        AssociatedRoles:
          type: array
          description: IAM roles associated with the cluster.
          items:
            $ref: '#/components/schemas/DBClusterRole'
    DBClusterRole:
      type: object
      description: An IAM role associated with a Neptune DB cluster.
      properties:
        RoleArn:
          type: string
          description: The ARN of the IAM role.
        Status:
          type: string
          description: The status of the association (active, pending, error).
    DescribeDBClustersResponse:
      type: object
      properties:
        DBClusters:
          type: array
          items:
            $ref: '#/components/schemas/DBCluster'
        Marker:
          type: string
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication