Amazon RDS Rds Db Cluster Snapshot API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Cluster Snapshot API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Db Cluster Snapshot
paths:
  /?Action=CreateDBClusterSnapshot:
    post:
      operationId: CreateDBClusterSnapshot
      summary: Create DBCluster Snapshot
      description: Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBClusterSnapshotResult'
              example:
                DBClusterSnapshot:
                  AvailabilityZones:
                  - us-east-1a
                  - us-east-1b
                  - us-east-1e
                  DBClusterSnapshotIdentifier: mydbclustersnapshot
                  DBClusterIdentifier: mydbcluster
                  SnapshotCreateTime: '2019-06-18T21:21:00.469Z'
                  Engine: aurora-mysql
                  AllocatedStorage: 1
                  Status: creating
                  Port: 0
                  VpcId: vpc-6594f31c
                  ClusterCreateTime: '2019-04-15T14:18:42.785Z'
                  MasterUsername: myadmin
                  EngineVersion: 5.7.mysql_aurora.2.04.2
                  LicenseModel: aurora-mysql
                  SnapshotType: manual
                  PercentProgress: 0
                  StorageEncrypted: true
                  KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE
                  DBClusterSnapshotArn: arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot
                  IAMDatabaseAuthenticationEnabled: false
        '404':
          description: DBClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: DBClusterSnapshotAlreadyExistsFault; InvalidDBClusterSnapshotStateFault; InvalidDBClusterStateFault; SnapshotQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterSnapshotAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBClusterSnapshot
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBClusterSnapshotMessage'
            example:
              DBClusterSnapshotIdentifier: mydbcluster
              DBClusterIdentifier: mydbclustersnapshot
      tags:
      - Db Cluster Snapshot
  /?Action=DeleteDBClusterSnapshot:
    post:
      operationId: DeleteDBClusterSnapshot
      summary: Delete DBCluster Snapshot
      description: Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteDBClusterSnapshotResult'
              example:
                DBClusterSnapshot:
                  AvailabilityZones:
                  - us-east-1a
                  - us-east-1b
                  - us-east-1e
                  DBClusterSnapshotIdentifier: mydbclustersnapshot
                  DBClusterIdentifier: mydbcluster
                  SnapshotCreateTime: '2019-06-18T21:21:00.469Z'
                  Engine: aurora-mysql
                  AllocatedStorage: 0
                  Status: available
                  Port: 0
                  VpcId: vpc-6594f31c
                  ClusterCreateTime: '2019-04-15T14:18:42.785Z'
                  MasterUsername: myadmin
                  EngineVersion: 5.7.mysql_aurora.2.04.2
                  LicenseModel: aurora-mysql
                  SnapshotType: manual
                  PercentProgress: 100
                  StorageEncrypted: true
                  KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE
                  DBClusterSnapshotArn: arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot
                  IAMDatabaseAuthenticationEnabled: false
        '404':
          description: DBClusterSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterSnapshotNotFoundFault'
        '400':
          description: InvalidDBClusterSnapshotStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBClusterSnapshotStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDBClusterSnapshot
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBClusterSnapshotMessage'
            example:
              DBClusterSnapshotIdentifier: mydbclustersnapshot
      tags:
      - Db Cluster Snapshot
  /?Action=DescribeDBClusterSnapshots:
    post:
      operationId: DescribeDBClusterSnapshots
      summary: Describe DBCluster Snapshots
      description: Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterSnapshotMessage'
              example:
                DBClusterSnapshots:
                - AvailabilityZones:
                  - us-east-1a
                  - us-east-1b
                  - us-east-1e
                  DBClusterSnapshotIdentifier: myclustersnapshotcopy
                  DBClusterIdentifier: mydbcluster
                  SnapshotCreateTime: '2019-06-04T09:16:42.649Z'
                  Engine: aurora-mysql
                  AllocatedStorage: 0
                  Status: available
                  Port: 0
                  VpcId: vpc-6594f31c
                  ClusterCreateTime: '2019-04-15T14:18:42.785Z'
                  MasterUsername: myadmin
                  EngineVersion: 5.7.mysql_aurora.2.04.2
                  LicenseModel: aurora-mysql
                  SnapshotType: manual
                  PercentProgress: 100
                  StorageEncrypted: true
                  KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE
                  DBClusterSnapshotArn: arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy
                  IAMDatabaseAuthenticationEnabled: false
                - AvailabilityZones:
                  - us-east-1a
                  - us-east-1b
                  - us-east-1e
                  DBClusterSnapshotIdentifier: rds:mydbcluster-2019-06-20-09-16
                  DBClusterIdentifier: mydbcluster
                  SnapshotCreateTime: '2019-06-20T09:16:26.569Z'
                  Engine: aurora-mysql
                  AllocatedStorage: 0
                  Status: available
                  Port: 0
                  VpcId: vpc-6594f31c
                  ClusterCreateTime: '2019-04-15T14:18:42.785Z'
                  MasterUsername: myadmin
                  EngineVersion: 5.7.mysql_aurora.2.04.2
                  LicenseModel: aurora-mysql
                  SnapshotType: automated
                  PercentProgress: 100
                  StorageEncrypted: true
                  KmsKeyId: arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE
                  DBClusterSnapshotArn: arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16
                  IAMDatabaseAuthenticationEnabled: false
        '404':
          description: DBClusterSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterSnapshotNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBClusterSnapshots
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBClusterSnapshotsMessage'
            example:
              DBClusterIdentifier: mydbcluster
      tags:
      - Db Cluster Snapshot
components:
  schemas:
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DBClusterSnapshotAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DBClusterSnapshotNotFoundFault:
      type: object
      properties:
        message:
          type: string
    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}_.:/=+\\-@]*)$").'
    DBClusterSnapshot:
      type: object
      properties:
        AvailabilityZones:
          type: array
          items:
            type: string
          description: The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
        DBClusterSnapshotIdentifier:
          type: string
          description: The identifier for the DB cluster snapshot.
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
        SnapshotCreateTime:
          type: string
          format: date-time
          description: The time when the snapshot was taken, in Universal Coordinated Time (UTC).
        Engine:
          type: string
          description: The name of the database engine for this DB cluster snapshot.
        EngineMode:
          type: string
          description: The engine mode of the database engine for this DB cluster snapshot.
        AllocatedStorage:
          type: integer
          description: The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
        Status:
          type: string
          description: 'The status of this DB cluster snapshot. Valid statuses are the following: available copying creating'
        Port:
          type: integer
          description: The port that the DB cluster was listening on at the time of the snapshot.
        VpcId:
          type: string
          description: The VPC ID associated with the DB cluster snapshot.
        ClusterCreateTime:
          type: string
          format: date-time
          description: The time when the DB cluster was created, in Universal Coordinated Time (UTC).
        MasterUsername:
          type: string
          description: The master username for this DB cluster snapshot.
        EngineVersion:
          type: string
          description: The version of the database engine for this DB cluster snapshot.
        LicenseModel:
          type: string
          description: The license model information for this DB cluster snapshot.
        SnapshotType:
          type: string
          description: The type of the DB cluster snapshot.
        PercentProgress:
          type: integer
          description: The percentage of the estimated data that has been transferred.
        StorageEncrypted:
          type: boolean
          description: Specifies whether the DB cluster snapshot is encrypted with an Amazon Web Services managed key or a customer managed key. If the DB cluster snapshot is encrypted with an Amazon Web Services owned key, this value is false and StorageEncryptionType is sse-rds. In that case, the data at rest is still encrypted. To determine how the data at rest is protected, use StorageEncryptionType.
        StorageEncryptionType:
          type: string
          enum:
          - none
          - sse-kms
          - sse-rds
          description: 'The type of encryption used to protect data at rest in the DB cluster snapshot. Possible values: none - The DB cluster snapshot is not encrypted. sse-rds - The DB cluster snapshot is encrypted using an Amazon Web Services owned KMS key. sse-kms - The DB cluster snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.'
        BackupRetentionPeriod:
          type: integer
          description: The number of days for which automatic DB snapshots are retained.
        PreferredBackupWindow:
          type: string
          description: The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
        KmsKeyId:
          type: string
          description: If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
        DBClusterSnapshotArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB cluster snapshot.
        SourceDBClusterSnapshotArn:
          type: string
          description: If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
        IAMDatabaseAuthenticationEnabled:
          type: boolean
          description: Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        StorageType:
          type: string
          description: The storage type associated with the DB cluster snapshot. This setting is only for Aurora DB clusters.
        StorageThroughput:
          type: integer
          description: The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters.
        DbClusterResourceId:
          type: string
          description: The resource ID of the DB cluster that this DB cluster snapshot was created from.
        DBSystemId:
          type: string
          description: Reserved for future use.
    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
    DBClusterSnapshotMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        DBClusterSnapshots:
          type: array
          items:
            $ref: '#/components/schemas/DBClusterSnapshot'
          description: Provides a list of DB cluster snapshots for the user.
    DeleteDBClusterSnapshotMessage:
      type: object
      properties:
        DBClusterSnapshotIdentifier:
          type: string
          description: 'The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state.'
      required:
      - DBClusterSnapshotIdentifier
    CreateDBClusterSnapshotMessage:
      type: object
      properties:
        DBClusterSnapshotIdentifier:
          type: string
          description: 'The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can''t end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1'
        DBClusterIdentifier:
          type: string
          description: 'The identifier of the DB cluster to create a snapshot for. This parameter isn''t case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the DB cluster snapshot.
      required:
      - DBClusterSnapshotIdentifier
      - DBClusterIdentifier
    CreateDBClusterSnapshotResult:
      type: object
      properties:
        DBClusterSnapshot:
          $ref: '#/components/schemas/DBClusterSnapshot'
    DescribeDBClusterSnapshotsMessage:
      type: object
      properties:
        DBClusterIdentifier:
          type: string
          description: 'The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can''t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn''t case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster.'
        DBClusterSnapshotIdentifier:
          type: string
          description: 'A specific DB cluster snapshot identifier to describe. This parameter can''t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.'
        SnapshotType:
          type: string
          description: 'The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account. shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. public - Return all DB cluster snapshots that have been marked as public. If you don''t specify a SnapshotType value, then both automated and manual DB cluster snapshots are re'
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'A filter that specifies one or more DB cluster snapshots to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers. snapshot-type - Accepts types of DB cluster snapshots. engine - Accepts names of database engines.'
        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 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 DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        IncludeShared:
          type: boolean
          description: Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
        IncludePublic:
          type: boolean
          description: Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
        DbClusterResourceId:
          type: string
          description: A specific DB cluster resource ID to describe.
    InvalidDBClusterSnapshotStateFault:
      type: object
      properties:
        message:
          type: string
    DeleteDBClusterSnapshotResult:
      type: object
      properties:
        DBClusterSnapshot:
          $ref: '#/components/schemas/DBClusterSnapshot'
  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)