Amazon RDS Rds Blue Green Deployment API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Blue Green Deployment 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: Blue Green Deployment
paths:
  /?Action=CreateBlueGreenDeployment:
    post:
      operationId: CreateBlueGreenDeployment
      summary: Create Blue Green Deployment
      description: Creates a blue/green deployment. A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment. You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateBlueGreenDeploymentResponse'
              example:
                BlueGreenDeployment:
                  BlueGreenDeploymentIdentifier: bgd-v53303651eexfake
                  BlueGreenDeploymentName: bgd-cli-test-instance
                  Source: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
                  SwitchoverDetails:
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3
                  Tasks:
                  - Name: CREATING_READ_REPLICA_OF_SOURCE
                    Status: PENDING
                  - Name: DB_ENGINE_VERSION_UPGRADE
                    Status: PENDING
                  - Name: CONFIGURE_BACKUPS
                    Status: PENDING
                  - Name: CREATING_TOPOLOGY_OF_SOURCE
                    Status: PENDING
                  Status: PROVISIONING
                  CreateTime: '2022-02-25T21:18:51.183Z'
        '400':
          description: BlueGreenDeploymentAlreadyExistsFault; InstanceQuotaExceededFault; InvalidDBClusterStateFault; InvalidDBInstanceStateFault; SourceClusterNotSupportedFault; SourceDatabaseNotSupportedFault; StorageQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BlueGreenDeploymentAlreadyExistsFault'
        '404':
          description: DBClusterNotFoundFault; DBClusterParameterGroupNotFoundFault; DBInstanceNotFoundFault; DBParameterGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '403':
          description: DBClusterQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterQuotaExceededFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateBlueGreenDeployment
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateBlueGreenDeploymentRequest'
            example:
              BlueGreenDeploymentName: bgd-test-instance
              Source: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
              TargetEngineVersion: '8.0'
              TargetDBParameterGroupName: mysql-80-group
      tags:
      - Blue Green Deployment
  /?Action=DeleteBlueGreenDeployment:
    post:
      operationId: DeleteBlueGreenDeployment
      summary: Delete Blue Green Deployment
      description: Deletes a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteBlueGreenDeploymentResponse'
              example:
                BlueGreenDeployment:
                  BlueGreenDeploymentIdentifier: bgd-v53303651eexfake
                  BlueGreenDeploymentName: bgd-cli-test-instance
                  Source: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
                  Target: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe
                  SwitchoverDetails:
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe
                    Status: AVAILABLE
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha
                    Status: AVAILABLE
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao
                    Status: AVAILABLE
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t
                    Status: AVAILABLE
                  Tasks:
                  - Name: CREATING_READ_REPLICA_OF_SOURCE
                    Status: COMPLETED
                  - Name: DB_ENGINE_VERSION_UPGRADE
                    Status: COMPLETED
                  - Name: CONFIGURE_BACKUPS
                    Status: COMPLETED
                  - Name: CREATING_TOPOLOGY_OF_SOURCE
                    Status: COMPLETED
                  Status: DELETING
                  CreateTime: '2022-02-25T21:18:51.183Z'
                  DeleteTime: '2022-02-25T22:25:31.331Z'
        '404':
          description: BlueGreenDeploymentNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BlueGreenDeploymentNotFoundFault'
        '400':
          description: InvalidBlueGreenDeploymentStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidBlueGreenDeploymentStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteBlueGreenDeployment
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteBlueGreenDeploymentRequest'
            example:
              BlueGreenDeploymentIdentifier: bgd-v53303651eexfake
              DeleteTarget: true
      tags:
      - Blue Green Deployment
  /?Action=DescribeBlueGreenDeployments:
    post:
      operationId: DescribeBlueGreenDeployments
      summary: Describe Blue Green Deployments
      description: Describes one or more blue/green deployments. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeBlueGreenDeploymentsResponse'
              example:
                BlueGreenDeployments:
                - BlueGreenDeploymentIdentifier: bgd-v53303651eexfake
                  BlueGreenDeploymentName: bgd-cli-test-instance
                  Source: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
                  Target: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe
                  SwitchoverDetails:
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe
                    Status: AVAILABLE
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha
                    Status: AVAILABLE
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao
                    Status: AVAILABLE
                  - SourceMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3
                    TargetMember: arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t
                    Status: AVAILABLE
                  Tasks:
                  - Name: CREATING_READ_REPLICA_OF_SOURCE
                    Status: COMPLETED
                  - Name: DB_ENGINE_VERSION_UPGRADE
                    Status: COMPLETED
                  - Name: CONFIGURE_BACKUPS
                    Status: COMPLETED
                  - Name: CREATING_TOPOLOGY_OF_SOURCE
                    Status: COMPLETED
                  Status: AVAILABLE
                  CreateTime: '2022-02-25T21:18:51.183Z'
        '404':
          description: BlueGreenDeploymentNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BlueGreenDeploymentNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeBlueGreenDeployments
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeBlueGreenDeploymentsRequest'
            example:
              BlueGreenDeploymentIdentifier: bgd-v53303651eexfake
      tags:
      - Blue Green Deployment
components:
  schemas:
    SwitchoverDetail:
      type: object
      properties:
        SourceMember:
          type: string
          description: The Amazon Resource Name (ARN) of a resource in the blue environment.
        TargetMember:
          type: string
          description: The Amazon Resource Name (ARN) of a resource in the green environment.
        Status:
          type: string
          description: 'The switchover status of a resource in a blue/green deployment. Values: PROVISIONING - The resource is being prepared to switch over. AVAILABLE - The resource is ready to switch over. SWITCHOVER_IN_PROGRESS - The resource is being switched over. SWITCHOVER_COMPLETED - The resource has been switched over. SWITCHOVER_FAILED - The resource attempted to switch over but failed. MISSING_SOURCE - The source resource has been deleted. MISSING_TARGET - The target resource has been deleted.'
    TargetResourceConfiguration:
      type: object
      properties:
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the DB cluster or DB instance in the blue environment to which this configuration applies.
        TargetKmsKeyId:
          type: string
          description: 'The Amazon Web Services KMS key identifier for encryption of the corresponding resource in the green environment. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Specify this setting in either of the following cases: You want the green resource to use a different KMS key than the blue resource. The blue resource is unencrypted and you want to encrypt the green resource. For Aurora, encryption applies at the DB cluster level. Specify a DB cluster ARN in SourceArn. All DB instances in that cluster use the same KMS key. For RDS, encrypt'
      required:
      - SourceArn
    BlueGreenDeployment:
      type: object
      properties:
        BlueGreenDeploymentIdentifier:
          type: string
          description: The unique identifier of the blue/green deployment.
        BlueGreenDeploymentName:
          type: string
          description: The user-supplied name of the blue/green deployment.
        Source:
          type: string
          description: The source database for the blue/green deployment. Before switchover, the source database is the production database in the blue environment.
        Target:
          type: string
          description: The target database for the blue/green deployment. Before switchover, the target database is the clone database in the green environment.
        SwitchoverDetails:
          type: array
          items:
            $ref: '#/components/schemas/SwitchoverDetail'
          description: The details about each source and target resource in the blue/green deployment.
        Tasks:
          type: array
          items:
            $ref: '#/components/schemas/BlueGreenDeploymentTask'
          description: Either tasks to be performed or tasks that have been completed on the target database before switchover.
        Status:
          type: string
          description: 'The status of the blue/green deployment. Valid Values: PROVISIONING - Resources are being created in the green environment. AVAILABLE - Resources are available in the green environment. SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment. SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete. INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn''t possible. SWITCHOVER_FAILED - Switchover was attempted but failed. DELETING - The blue/green deployment is being d'
        StatusDetails:
          type: string
          description: Additional information about the status of the blue/green deployment.
        CreateTime:
          type: string
          format: date-time
          description: The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
        DeleteTime:
          type: string
          format: date-time
          description: The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    CreateBlueGreenDeploymentRequest:
      type: object
      properties:
        BlueGreenDeploymentName:
          type: string
          description: 'The name of the blue/green deployment. Constraints: Can''t be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.'
        Source:
          type: string
          description: The Amazon Resource Name (ARN) of the source production database. Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
        TargetEngineVersion:
          type: string
          description: The engine version of the database in the green environment. Specify the engine version to upgrade to in the green environment.
        TargetDBParameterGroupName:
          type: string
          description: The DB parameter group associated with the DB instance in the green environment. To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
        TargetDBClusterParameterGroupName:
          type: string
          description: The DB cluster parameter group associated with the Aurora DB cluster in the green environment. To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to assign to the blue/green deployment.
        TargetDBInstanceClass:
          type: string
          description: Specify the DB instance class for the databases in the green environment. This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
        UpgradeTargetStorageConfig:
          type: boolean
          description: Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
        TargetIops:
          type: integer
          description: The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora blue/green deployments.
        TargetStorageType:
          type: string
          description: 'The storage type to associate with the green DB instance. Valid Values: gp2 | gp3 | io1 | io2 This setting doesn''t apply to Amazon Aurora blue/green deployments.'
        TargetAllocatedStorage:
          type: integer
          description: The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance. This setting doesn't apply to Amazon Aurora blue/green deployments.
        TargetStorageThroughput:
          type: integer
          description: The storage throughput value for the green DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora blue/green deployments.
        TargetResourceConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TargetResourceConfiguration'
          description: 'Specifies resource-level configuration overrides for the green environment. Each entry identifies a resource in the blue environment by its Amazon Resource Name (ARN). It defines the desired configuration for the corresponding resource in the green environment. Any resource that you don''t include in this parameter retains the same configuration as its counterpart in the blue environment. Use this parameter when one or more resources in the green environment require a different configuration than what they have in the blue environment. Constraints: You can''t specify the same SourceArn in more t'
      required:
      - BlueGreenDeploymentName
      - Source
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DescribeBlueGreenDeploymentsResponse:
      type: object
      properties:
        BlueGreenDeployments:
          type: array
          items:
            $ref: '#/components/schemas/BlueGreenDeployment'
          description: A list of blue/green deployments in the current account and Amazon Web Services Region.
        Marker:
          type: string
          description: A pagination token that can be used in a later DescribeBlueGreenDeployments request.
    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}_.:/=+\\-@]*)$").'
    DescribeBlueGreenDeploymentsRequest:
      type: object
      properties:
        BlueGreenDeploymentIdentifier:
          type: string
          description: 'The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn''t case-sensitive. Constraints: Must match an existing blue/green deployment identifier.'
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'A filter that specifies one or more blue/green deployments to describe. Valid Values: blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers. blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names. source - Accepts source databases for a blue/green deployment. The results list only includes information about the blu'
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by MaxRecords.
        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: Must be a minimum of 20. Can''t exceed 100.'
    BlueGreenDeploymentAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    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
    BlueGreenDeploymentTask:
      type: object
      properties:
        Name:
          type: string
          description: The name of the blue/green deployment task.
        Status:
          type: string
          description: 'The status of the blue/green deployment task. Valid Values: PENDING - The resource is being prepared for deployment. IN_PROGRESS - The resource is being deployed. COMPLETED - The resource has been deployed. FAILED - Deployment of the resource failed.'
    BlueGreenDeploymentNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DeleteBlueGreenDeploymentResponse:
      type: object
      properties:
        BlueGreenDeployment:
          $ref: '#/components/schemas/BlueGreenDeployment'
    DBClusterQuotaExceededFault:
      type: object
      properties:
        message:
          type: string
    CreateBlueGreenDeploymentResponse:
      type: object
      properties:
        BlueGreenDeployment:
          $ref: '#/components/schemas/BlueGreenDeployment'
    DeleteBlueGreenDeploymentRequest:
      type: object
      properties:
        BlueGreenDeploymentIdentifier:
          type: string
          description: 'The unique identifier of the blue/green deployment to delete. This parameter isn''t case-sensitive. Constraints: Must match an existing blue/green deployment identifier.'
        DeleteTarget:
          type: boolean
          description: Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
      required:
      - BlueGreenDeploymentIdentifier
    InvalidBlueGreenDeploymentStateFault:
      type: object
      properties:
        message:
          type: string
  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)