Amazon DMS #X Amz Target=AmazonDMSv20160101.CreateEndpoint API

openapi: 3.2.0
info:
  version: 2016-01-01
  x-release: v4
  title: 'AWS Database Migration Service #X Amz Target=AmazonDMSv20160101.CreateEndpoint API'
  description: <fullname>Database Migration Service</fullname> <p>Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p> <p>For more information about DMS, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html">What Is Database Migration Service?</a> in the <i>Database Migration Service User Guide.</i> </p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: dms
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/dms-2016-01-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://dms.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Database Migration Service multi-region endpoint
- url: https://dms.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Database Migration Service multi-region endpoint
- url: http://dms.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia)
- url: https://dms.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AmazonDMSv20160101.CreateEndpoint'
paths:
  /#X-Amz-Target=AmazonDMSv20160101.CreateEndpoint:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateEndpoint
      description: <p>Creates an endpoint using the provided settings.</p> <note> <p>For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on the <code>CreateEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEndpointResponse'
        '480':
          description: KMSKeyNotAccessibleFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KMSKeyNotAccessibleFault'
        '481':
          description: ResourceAlreadyExistsFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsFault'
        '482':
          description: ResourceQuotaExceededFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceQuotaExceededFault'
        '483':
          description: InvalidResourceStateFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceStateFault'
        '484':
          description: ResourceNotFoundFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
        '485':
          description: AccessDeniedFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedFault'
        '486':
          description: S3AccessDeniedFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3AccessDeniedFault'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEndpointMessage'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.CreateEndpoint
      tags:
      - '#X Amz Target=AmazonDMSv20160101.CreateEndpoint'
components:
  schemas:
    DatePartitionDelimiterValue:
      type: string
      enum:
      - SLASH
      - UNDERSCORE
      - DASH
      - NONE
    DatePartitionSequenceValue:
      type: string
      enum:
      - YYYYMMDD
      - YYYYMMDDHH
      - YYYYMM
      - MMYYYYDD
      - DDMMYYYY
    DmsSslModeValue:
      type: string
      enum:
      - none
      - require
      - verify-ca
      - verify-full
    CompressionTypeValue:
      type: string
      enum:
      - none
      - gzip
    MySQLSettings:
      type: object
      properties:
        AfterConnectScript:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.</p> <p>For this parameter, provide the code of the script itself, not the name of a file containing the script.</p>
        CleanSourceMetadataOnMismatch:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: 'Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. '
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on either the <code>CreateEndpoint</code> or <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
        EventsPollInterval:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: '<p>Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.</p> <p>Example: <code>eventsPollInterval=5;</code> </p> <p>In the example, DMS checks for changes in the binary logs every five seconds.</p>'
        TargetDbType:
          allOf:
          - $ref: '#/components/schemas/TargetDbType'
          - description: '<p>Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify <code>SPECIFIC_DATABASE</code>, specify the database name using the <code>DatabaseName</code> parameter of the <code>Endpoint</code> object.</p> <p>Example: <code>targetDbType=MULTIPLE_DATABASES</code> </p>'
        MaxFileSize:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: '<p>Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.</p> <p>Example: <code>maxFileSize=512</code> </p>'
        ParallelLoadThreads:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: '<p>Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.</p> <p>Example: <code>parallelLoadThreads=1</code> </p>'
        Password:
          allOf:
          - $ref: '#/components/schemas/SecretString'
          - description: Endpoint connection password.
        Port:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: Endpoint TCP port.
        ServerName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The host name of the endpoint database. </p> <p>For an Amazon RDS MySQL instance, this is the output of <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html">DescribeDBInstances</a>, in the <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code> field.</p> <p>For an Aurora MySQL instance, this is the output of <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html">DescribeDBClusters</a>, in the <code>Endpoint</code> field.</p>
        ServerTimezone:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>Specifies the time zone for the source MySQL database.</p> <p>Example: <code>serverTimezone=US/Pacific;</code> </p> <p>Note: Do not enclose time zones in single quotes.</p>'
        Username:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Endpoint connection user name.
        SecretsManagerAccessRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.</p> <note> <p>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</p> </note>
        SecretsManagerSecretId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MySQL endpoint connection details.
      description: Provides information that defines a MySQL endpoint.
    IntegerOptional:
      type: integer
    NestingLevelValue:
      type: string
      enum:
      - none
      - one
    BooleanOptional:
      type: boolean
    PluginNameValue:
      type: string
      enum:
      - no-preference
      - test-decoding
      - pglogical
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
    KinesisSettings:
      type: object
      properties:
        StreamArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
        MessageFormat:
          allOf:
          - $ref: '#/components/schemas/MessageFormatValue'
          - description: The output format for the records created on the endpoint. The message format is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line with no tab).
        ServiceAccessRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the <code>iam:PassRole</code> action.
        IncludeTransactionDetails:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for <code>transaction_id</code>, previous <code>transaction_id</code>, and <code>transaction_record_id</code> (the record offset within a transaction). The default is <code>false</code>.
        IncludePartitionValue:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Shows the partition value within the Kinesis message output, unless the partition type is <code>schema-table-type</code>. The default is <code>false</code>.
        PartitionIncludeSchemaTable:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Prefixes schema and table names to partition values, when the partition type is <code>primary-key-type</code>. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is <code>false</code>.
        IncludeTableAlterOperations:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Includes any data definition language (DDL) operations that change the table in the control data, such as <code>rename-table</code>, <code>drop-table</code>, <code>add-column</code>, <code>drop-column</code>, and <code>rename-column</code>. The default is <code>false</code>.
        IncludeControlDetails:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is <code>false</code>.
        IncludeNullAndEmpty:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Include NULL and empty columns for records migrated to the endpoint. The default is <code>false</code>.
        NoHexPrefix:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Set this optional parameter to <code>true</code> to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the <code>NoHexPrefix</code> endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
      description: Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.
    Tag:
      type: object
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/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:
          allOf:
          - $ref: '#/components/schemas/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:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
      description: <p>A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:</p> <ul> <li> <p> <code>AddTagsToResource</code> </p> </li> <li> <p> <code>ListTagsForResource</code> </p> </li> <li> <p> <code>RemoveTagsFromResource</code> </p> </li> </ul>
    MicrosoftSQLServerSettings:
      type: object
      properties:
        Port:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: Endpoint TCP port.
        BcpPacketSize:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: The maximum size of the packets (in bytes) used to transfer data using BCP.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Database name for the endpoint.
        ControlTablesFileGroup:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
        Password:
          allOf:
          - $ref: '#/components/schemas/SecretString'
          - description: Endpoint connection password.
        QuerySingleAlwaysOnNode:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.
        ReadBackupOnly:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: When this attribute is set to <code>Y</code>, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to <code>Y</code> enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
        SafeguardPolicy:
          allOf:
          - $ref: '#/components/schemas/SafeguardPolicy'
          - description: '<p>Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.</p> <p> <i>Start transactions in the database:</i> This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren''t truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.</p> <p> <i>Exclusively use sp_repldone within a single task</i>: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn''t involve any transactional activities, it can only be used when Microsoft Replication isn''t running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.</p>'
        ServerName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html">DescribeDBInstances</a>, in the <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code> field.
        Username:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Endpoint connection user name.
        UseBcpFullLoad:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
        UseThirdPartyBackupDevice:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: When this attribute is set to <code>Y</code>, DMS processes third-party transaction log backups if they are created in native format.
        SecretsManagerAccessRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint.</p> <note> <p>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</p> </note>
        SecretsManagerSecretId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the SQL Server endpoint connection details.
        TrimSpaceInChar:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.
        TlogAccessMode:
          allOf:
          - $ref: '#/components/schemas/TlogAccessMode'
          - description: Indicates the mode used to fetch CDC data.
        ForceLobLookup:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Forces LOB lookup on inline LOB.
      description: Provides information that defines a Microsoft SQL Server endpoint.
    CannedAclForObjectsValue:
      type: string
      enum:
      - none
      - private
      - public-read
      - public-read-write
      - authenticated-read
      - aws-exec-read
      - bucket-owner-read
      - bucket-owner-full-control
    IBMDb2Settings:
      type: object
      properties:
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Database name for the endpoint.
        Password:
          allOf:
          - $ref: '#/components/schemas/SecretString'
          - description: Endpoint connection password.
        Port:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: Endpoint TCP port. The default value is 50000.
        ServerName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Fully qualified domain name of the endpoint.
        SetDataCaptureChanges:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
        CurrentLsn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
        MaxKBytesPerRead:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
        Username:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Endpoint connection user name.
        SecretsManagerAccessRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint. </p> <note> <p>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</p> </note>
        SecretsManagerSecretId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Db2 LUW endpoint connection details.
      description: Provides information that defines an IBM Db2 LUW endpoint.
    OracleSettings:
      type: object
      properties:
        AddSupplementalLogging:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: <p>Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.</p> <p>If you use this option, you still need to enable database-level supplemental logging.</p>
        ArchivedLogDestId:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the <code>AdditionalArchivedLogDestId</code> option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
        AdditionalArchivedLogDestId:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: <p>Set this attribute with <code>ArchivedLogDestId</code> in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.</p> <p>Although DMS supports the use of the Oracle <code>RESETLOGS</code> option to open the database, never use <code>RESETLOGS</code> unless necessary. For additional information about <code>RESETLOGS</code>, see <a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B">RMAN Data Repair Concepts</a> in the <i>Oracle Database Backup and Recovery User's Guide</i>.</p>
        ExtraArchivedLogDestIds:
          allOf:
          - $ref: '#/components/schemas/IntegerList'
          - description: <p>Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the <code>dest_id</code> column in the <code>v$archived_log</code> view. Use this setting with the <code>archivedLogDestId</code> extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup. </p> <p>This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings. </p> <p> <code>archivedLogDestId=1; ExtraArchivedLogDestIds=[2]</code> </p> <p>In a primary-to-multiple-standby setup, you might apply the following settings.</p> <p> <code>archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]</code> </p> <p>Although DMS supports the use of the Oracle <code>RESETLOGS</code> option to open the database, never use <code>RESETLOGS</code> unless it's necessary. For more information about <code>RESETLOGS</code>, see <a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B"> RMAN Data Repair Concepts</a> in the <i>Oracle Database Backup and Recovery User's Guide</i>.</p>
        AllowSelectNestedTables:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: Set this attribute to <code>true</code> to enable replication of Oracle tables containing columns that are nested tables or defined types.
   

# --- truncated at 32 KB (152 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-dms/refs/heads/main/openapi/amazon-dms-x-amz-target-amazondmsv20160101-createendpoint-api-openapi.yml