Amazon DMS Dms Replication Config API

openapi: 3.2.0
info:
  title: AWS Database Migration Service Replication Config API
  version: '2016-01-01'
  description: Generated from AWS's published Smithy model for AWS Database Migration 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://dms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Replication Config
paths:
  /#CreateReplicationConfig:
    post:
      operationId: CreateReplicationConfig
      summary: Create Replication Config
      description: Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateReplicationConfigResponse'
        '400':
          description: AccessDeniedFault; InvalidResourceStateFault; InvalidSubnet; KMSKeyNotAccessibleFault; ReplicationSubnetGroupDoesNotCoverEnoughAZs; ResourceAlreadyExistsFault; ResourceNotFoundFault; ResourceQuotaExceededFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.CreateReplicationConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateReplicationConfigMessage'
      tags:
      - Replication Config
  /#DeleteReplicationConfig:
    post:
      operationId: DeleteReplicationConfig
      summary: Delete Replication Config
      description: Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteReplicationConfigResponse'
        '400':
          description: AccessDeniedFault; InvalidResourceStateFault; ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.DeleteReplicationConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteReplicationConfigMessage'
      tags:
      - Replication Config
  /#DescribeReplicationConfigs:
    post:
      operationId: DescribeReplicationConfigs
      summary: Describe Replication Configs
      description: Returns one or more existing DMS Serverless replication configurations as a list of structures.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeReplicationConfigsResponse'
        '400':
          description: ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.DescribeReplicationConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeReplicationConfigsMessage'
      tags:
      - Replication Config
  /#ModifyReplicationConfig:
    post:
      operationId: ModifyReplicationConfig
      summary: Modify Replication Config
      description: Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it. Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ModifyReplicationConfigResponse'
        '400':
          description: AccessDeniedFault; InvalidResourceStateFault; InvalidSubnet; KMSKeyNotAccessibleFault; ReplicationSubnetGroupDoesNotCoverEnoughAZs; ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.ModifyReplicationConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ModifyReplicationConfigMessage'
      tags:
      - Replication Config
components:
  schemas:
    ReplicationConfig:
      type: object
      properties:
        ReplicationConfigIdentifier:
          type: string
          description: The identifier for the ReplicationConfig associated with the replication.
        ReplicationConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of this DMS Serverless replication configuration.
        SourceEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.
        TargetEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
        ReplicationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: The type of the replication.
        ComputeConfig:
          $ref: '#/components/schemas/ComputeConfig'
        ReplicationSettings:
          type: string
          description: Configuration parameters for an DMS serverless replication.
        SupplementalSettings:
          type: string
          description: Additional parameters for an DMS serverless replication.
        TableMappings:
          type: string
          description: Table mappings specified in the replication.
        ReplicationConfigCreateTime:
          type: string
          format: date-time
          description: The time the serverless replication config was created.
        ReplicationConfigUpdateTime:
          type: string
          format: date-time
          description: The time the serverless replication config was updated.
        IsReadOnly:
          type: boolean
          description: Indicates whether the replication configuration is read-only. When set to true, this replication configuration is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only replication configurations through their associated zero-ETL integration.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        Value:
          type: string
          description: 'A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
    CreateReplicationConfigMessage:
      type: object
      properties:
        ReplicationConfigIdentifier:
          type: string
          description: A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action. You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.
        SourceEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint for this DMS Serverless replication configuration.
        TargetEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
        ComputeConfig:
          $ref: '#/components/schemas/ComputeConfig'
        ReplicationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: 'The type of DMS Serverless replication to provision using this replication configuration. Possible values: "full-load" "cdc" "full-load-and-cdc"'
        TableMappings:
          type: string
          description: JSON table mappings for DMS Serverless replications that are provisioned using this replication configuration. For more information, see Specifying table selection and transformations rules using JSON.
        ReplicationSettings:
          type: string
          description: Optional JSON settings for DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.
        SupplementalSettings:
          type: string
          description: Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.
        ResourceIdentifier:
          type: string
          description: Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more optional tags associated with resources used by the DMS Serverless replication. For more information, see Tagging resources in Database Migration Service.
      required:
      - ReplicationConfigIdentifier
      - SourceEndpointArn
      - TargetEndpointArn
      - ComputeConfig
      - ReplicationType
      - TableMappings
    AccessDeniedFault:
      type: object
      properties:
        message:
          type: string
    DescribeReplicationConfigsMessage:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: Filters applied to the replication configs.
        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 the remaining results can be retrieved.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    ResourceNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ModifyReplicationConfigMessage:
      type: object
      properties:
        ReplicationConfigArn:
          type: string
          description: The Amazon Resource Name of the replication to modify.
        ReplicationConfigIdentifier:
          type: string
          description: The new replication config to apply to the replication.
        ReplicationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: The type of replication.
        TableMappings:
          type: string
          description: Table mappings specified in the replication.
        ReplicationSettings:
          type: string
          description: The settings for the replication.
        SupplementalSettings:
          type: string
          description: Additional settings for the replication.
        ComputeConfig:
          $ref: '#/components/schemas/ComputeConfig'
        SourceEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.
        TargetEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
      required:
      - ReplicationConfigArn
    DescribeReplicationConfigsResponse:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        ReplicationConfigs:
          type: array
          items:
            $ref: '#/components/schemas/ReplicationConfig'
          description: Returned configuration parameters that describe each provisioned DMS Serverless replication.
    DeleteReplicationConfigResponse:
      type: object
      properties:
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter as specified for a Describe* or similar operation.
        Values:
          type: array
          items:
            type: string
          description: The filter value, which can specify one or more values used to narrow the returned results.
      required:
      - Name
      - Values
    DeleteReplicationConfigMessage:
      type: object
      properties:
        ReplicationConfigArn:
          type: string
          description: The replication config to delete.
      required:
      - ReplicationConfigArn
    ModifyReplicationConfigResponse:
      type: object
      properties:
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
    ComputeConfig:
      type: object
      properties:
        AvailabilityZone:
          type: string
          description: The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration's Amazon Web Services Region, for example, "us-west-2". You can't set this parameter if the MultiAZ parameter is set to true.
        DnsNameServers:
          type: string
          description: 'A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"'
        KmsKeyId:
          type: string
          description: An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
        MaxCapacityUnits:
          type: integer
          description: Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only DCU parameter you are required to specify.
        MinCapacityUnits:
          type: integer
          description: Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. If you don't set this value, DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it reaches the value specified in MinCapacityUnits.
        MultiAZ:
          type: boolean
          description: Specifies whether the DMS Serverless replication is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
        PreferredMaintenanceWindow:
          type: string
          description: The weekly time range during which system maintenance can occur for the DMS Serverless replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi. The default is a 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region. This maintenance occurs on a random day of the week. Valid values for days of the week include Mon, Tue, Wed, Thu, Fri, Sat, and Sun. Constraints include a minimum 30-minute window.
        ReplicationSubnetGroupId:
          type: string
          description: Specifies a subnet group identifier to associate with the DMS Serverless replication.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
    CreateReplicationConfigResponse:
      type: object
      properties:
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
  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: dms
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)