DMS

10 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

DMSCertificate # CLOUD CONTROL · AWS::DMS::Certificate

DMSCertificate manages AWS::DMS::Certificate through the AWS Cloud Control API.

kubectl get dmscertificates · example on GitHub

Example

# DMSCertificate — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmscertificate
apiVersion: aws.konfig.io/v1alpha1
kind: DMSCertificate
metadata:
  name: example-dmscertificate
  namespace: default
spec:
  certificateIdentifier: example
  certificatePem: example
  certificateWallet: example
  providerRef:
    name: example-dmscertificate
    region: us-east-1

Spec

Field	Type	Required	Description
`certificateIdentifier`	string	—	The certificate Identifier Create-only in AWS: changing it requires replacing the resource.
`certificatePem`	string	—	The certificate Pem Create-only in AWS: changing it requires replacing the resource.
`certificateWallet`	string	—	The certificate Wallet Create-only in AWS: changing it requires replacing the resource.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`certificateArn`	string	—	The certificate Arn Read-only: reported by AWS after creation.
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSDataMigration # CLOUD CONTROL · AWS::DMS::DataMigration

DMSDataMigration manages AWS::DMS::DataMigration through the AWS Cloud Control API.

kubectl get dmsdatamigrations · example on GitHub

Example

# DMSDataMigration — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsdatamigration
apiVersion: aws.konfig.io/v1alpha1
kind: DMSDataMigration
metadata:
  name: example-dmsdatamigration
  namespace: default
spec:
  dataMigrationIdentifier: example
  dataMigrationName: example-dmsdatamigration
  dataMigrationSettings:
    cloudwatchLogsEnabled: true
    numberOfJobs: 1
    selectionRules: example
  dataMigrationType: full-load
  migrationProjectIdentifier: example
  providerRef:
    name: example-dmsdatamigration
    region: us-east-1
  serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  sourceDataSettings:
  - cdcStartPosition: example
    cdcStartTime: '2026-01-01T00:00:00Z'
    cdcStopTime: '2026-01-01T00:00:00Z'
    slotName: example-dmsdatamigration
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`dataMigrationIdentifier`	string	—	The property describes an ARN of the data migration.
`dataMigrationName`	string	—	The property describes a name to identify the data migration.
`dataMigrationSettings`	object	—	The property describes the settings for the data migration.
`dataMigrationSettings.cloudwatchLogsEnabled`	boolean	—	The property specifies whether to enable the CloudWatch log.
`dataMigrationSettings.numberOfJobs`	integer	—	The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
`dataMigrationSettings.selectionRules`	string	—	The property specifies the rules of selecting objects for data migration.
`dataMigrationType`	enum	yes	The property describes the type of migration. Allowed: `full-load, cdc, full-load-and-cdc`
`migrationProjectIdentifier`	string	yes	The property describes an identifier for the migration project.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`serviceAccessRoleArn`	string	yes	The property describes Amazon Resource Name (ARN) of the service access role.
`sourceDataSettings`	array<object>	—	The property describes the settings for the data migration.
`sourceDataSettings[].cdcStartPosition`	string	—	The property is a point in the database engine's log that defines a time where you can begin CDC.
`sourceDataSettings[].cdcStartTime`	string	—	The property indicates the start time for a change data capture (CDC) operation.
`sourceDataSettings[].cdcStopTime`	string	—	The property indicates the stop time for a change data capture (CDC) operation.
`sourceDataSettings[].slotName`	string	—	The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`dataMigrationArn`	string	—	The property describes an ARN of the data migration.
`dataMigrationCreateTime`	string	—	The property describes the create time of the data migration.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSDataProvider # CLOUD CONTROL · AWS::DMS::DataProvider

DMSDataProvider manages AWS::DMS::DataProvider through the AWS Cloud Control API.

kubectl get dmsdataproviders · example on GitHub

Example

# DMSDataProvider — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsdataprovider
apiVersion: aws.konfig.io/v1alpha1
kind: DMSDataProvider
metadata:
  name: example-dmsdataprovider
  namespace: default
spec:
  dataProviderIdentifier: example
  dataProviderName: example-dmsdataprovider
  description: Managed by konfig-konector
  engine: aurora
  exactSettings: false
  providerRef:
    name: example-dmsdataprovider
    region: us-east-1
  settings:
    docDbSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    ibmDb2LuwSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    ibmDb2zOsSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    mariaDbSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    microsoftSqlServerSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    mongoDbSettings:
      authMechanism: default
      authSource: example
      authType: 'no'
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    mySqlSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    oracleSettings:
      asmServer: example
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      secretsManagerOracleAsmAccessRoleArn: arn:aws:iam::123456789012:role/example-role
      secretsManagerSecurityDbEncryptionAccessRoleArn: arn:aws:iam::123456789012:role/example-role
      serverName: example-dmsdataprovider
      sslMode: none
    postgreSqlSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
    redshiftSettings:
      databaseName: example-dmsdataprovider
      port: 443
      serverName: example-dmsdataprovider
    sybaseAseSettings:
      certificateArn: arn:aws:iam::123456789012:role/example-role
      databaseName: example-dmsdataprovider
      encryptPassword: true
      port: 443
      serverName: example-dmsdataprovider
      sslMode: none
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`dataProviderIdentifier`	string	—	The property describes an identifier for the data provider.
`dataProviderName`	string	—	The property describes a name to identify the data provider.
`description`	string	—	The optional description of the data provider.
`engine`	enum	yes	The property describes a data engine for the data provider. Allowed: `aurora, aurora_postgresql, mysql, oracle, postgres, sqlserver, redshift, mariadb…`
`exactSettings`	boolean	—	The property describes the exact settings which can be modified
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`settings`	object	—	The property identifies the exact type of settings for the data provider.
`settings.docDbSettings`	object	—	DocDbSettings property identifier.
`settings.docDbSettings.certificateArn`	string	—
`settings.docDbSettings.databaseName`	string	yes
`settings.docDbSettings.port`	integer	yes
`settings.docDbSettings.serverName`	string	yes
`settings.docDbSettings.sslMode`	enum	—	Allowed: `none, require, verify-full`
`settings.ibmDb2LuwSettings`	object	—	IbmDb2LuwSettings property identifier.
`settings.ibmDb2LuwSettings.certificateArn`	string	—
`settings.ibmDb2LuwSettings.databaseName`	string	yes
`settings.ibmDb2LuwSettings.port`	integer	yes
`settings.ibmDb2LuwSettings.serverName`	string	yes
`settings.ibmDb2LuwSettings.sslMode`	enum	yes	Allowed: `none, verify-ca`
`settings.ibmDb2zOsSettings`	object	—	IbmDb2zOsSettings property identifier.
`settings.ibmDb2zOsSettings.certificateArn`	string	—
`settings.ibmDb2zOsSettings.databaseName`	string	yes
`settings.ibmDb2zOsSettings.port`	integer	yes
`settings.ibmDb2zOsSettings.serverName`	string	yes
`settings.ibmDb2zOsSettings.sslMode`	enum	yes	Allowed: `none, verify-ca`
`settings.mariaDbSettings`	object	—	MariaDbSettings property identifier.
`settings.mariaDbSettings.certificateArn`	string	—
`settings.mariaDbSettings.port`	integer	yes
`settings.mariaDbSettings.serverName`	string	yes
`settings.mariaDbSettings.sslMode`	enum	yes	Allowed: `none, require, verify-ca, verify-full`
`settings.microsoftSqlServerSettings`	object	—	MicrosoftSqlServerSettings property identifier.
`settings.microsoftSqlServerSettings.certificateArn`	string	—
`settings.microsoftSqlServerSettings.databaseName`	string	yes
`settings.microsoftSqlServerSettings.port`	integer	yes
`settings.microsoftSqlServerSettings.serverName`	string	yes
`settings.microsoftSqlServerSettings.sslMode`	enum	yes	Allowed: `none, require, verify-ca, verify-full`
`settings.mongoDbSettings`	object	—	MongoDbSettings property identifier.
`settings.mongoDbSettings.authMechanism`	enum	—	Allowed: `default, mongodb_cr, scram_sha_1`
`settings.mongoDbSettings.authSource`	string	—
`settings.mongoDbSettings.authType`	enum	—	Allowed: `no, password`
`settings.mongoDbSettings.certificateArn`	string	—
`settings.mongoDbSettings.databaseName`	string	—
`settings.mongoDbSettings.port`	integer	yes
`settings.mongoDbSettings.serverName`	string	yes
`settings.mongoDbSettings.sslMode`	enum	—	Allowed: `none, require, verify-full`
`settings.mySqlSettings`	object	—	MySqlSettings property identifier.
`settings.mySqlSettings.certificateArn`	string	—
`settings.mySqlSettings.port`	integer	yes
`settings.mySqlSettings.serverName`	string	yes
`settings.mySqlSettings.sslMode`	enum	yes	Allowed: `none, require, verify-ca, verify-full`
`settings.oracleSettings`	object	—	OracleSettings property identifier.
`settings.oracleSettings.asmServer`	string	—
`settings.oracleSettings.certificateArn`	string	—
`settings.oracleSettings.databaseName`	string	yes
`settings.oracleSettings.port`	integer	yes
`settings.oracleSettings.secretsManagerOracleAsmAccessRoleArn`	string	—
`settings.oracleSettings.secretsManagerOracleAsmSecretId`	string	—
`settings.oracleSettings.secretsManagerSecurityDbEncryptionAccessRoleArn`	string	—
`settings.oracleSettings.secretsManagerSecurityDbEncryptionSecretId`	string	—
`settings.oracleSettings.serverName`	string	yes
`settings.oracleSettings.sslMode`	enum	yes	Allowed: `none, require, verify-ca, verify-full`
`settings.postgreSqlSettings`	object	—	PostgreSqlSettings property identifier.
`settings.postgreSqlSettings.certificateArn`	string	—
`settings.postgreSqlSettings.databaseName`	string	yes
`settings.postgreSqlSettings.port`	integer	yes
`settings.postgreSqlSettings.serverName`	string	yes
`settings.postgreSqlSettings.sslMode`	enum	yes	Allowed: `none, require, verify-ca, verify-full`
`settings.redshiftSettings`	object	—	RedshiftSettings property identifier.
`settings.redshiftSettings.databaseName`	string	yes
`settings.redshiftSettings.port`	integer	yes
`settings.redshiftSettings.serverName`	string	yes
`settings.sybaseAseSettings`	object	—	SybaseAseSettings property identifier.
`settings.sybaseAseSettings.certificateArn`	string	—
`settings.sybaseAseSettings.databaseName`	string	—
`settings.sybaseAseSettings.encryptPassword`	boolean	—
`settings.sybaseAseSettings.port`	integer	yes
`settings.sybaseAseSettings.serverName`	string	yes
`settings.sybaseAseSettings.sslMode`	enum	yes	Allowed: `none, require, verify-ca`
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`dataProviderArn`	string	—	The data provider ARN.
`dataProviderCreationTime`	string	—	The data provider creation time.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSEndpoint # CLOUD CONTROL · AWS::DMS::Endpoint

DMSEndpoint manages AWS::DMS::Endpoint through the AWS Cloud Control API.

kubectl get dmsendpoints · example on GitHub

Example

# DMSEndpoint — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsendpoint
apiVersion: aws.konfig.io/v1alpha1
kind: DMSEndpoint
metadata:
  name: example-dmsendpoint
  namespace: default
spec:
  certificateArn: arn:aws:iam::123456789012:role/example-role
  databaseName: example-dmsendpoint
  docDbSettings:
    docsToInvestigate: 1
    extractDocId: false
    nestingLevel: example
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  dynamoDbSettings:
    serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  elasticsearchSettings:
    endpointUri: example
    errorRetryDuration: 1
    fullLoadErrorPercentage: 1
    serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  endpointIdentifier: example
  endpointType: example
  engineName: example-dmsendpoint
  extraConnectionAttributes: example
  gcpMySQLSettings:
    afterConnectScript: example
    cleanSourceMetadataOnMismatch: false
    databaseName: example-dmsendpoint
    eventsPollInterval: 1
    maxFileSize: 2
    parallelLoadThreads: 1
    password: example
    port: 443
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    serverName: example-dmsendpoint
    serverTimezone: example
    username: example-dmsendpoint
  ibmDb2Settings:
    currentLsn: example
    keepCsvFiles: false
    loadTimeout: 300
    maxFileSize: 2
    maxKBytesPerRead: 1
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    setDataCaptureChanges: false
    writeBufferSize: 2
  kafkaSettings:
    broker: example
    includeControlDetails: false
    includeNullAndEmpty: false
    includePartitionValue: false
    includeTableAlterOperations: false
    includeTransactionDetails: false
    messageFormat: example
    messageMaxBytes: 1
    noHexPrefix: false
    partitionIncludeSchemaTable: false
    saslPassword: example
    saslUserName: example-dmsendpoint
    securityProtocol: example
    sslCaCertificateArn: arn:aws:iam::123456789012:role/example-role
    sslClientCertificateArn: arn:aws:iam::123456789012:role/example-role
    sslClientKeyArn: arn:aws:iam::123456789012:role/example-role
    sslClientKeyPassword: example
    topic: example
  kinesisSettings:
    includeControlDetails: false
    includeNullAndEmpty: false
    includePartitionValue: false
    includeTableAlterOperations: false
    includeTransactionDetails: false
    messageFormat: example
    noHexPrefix: false
    partitionIncludeSchemaTable: false
    serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    streamArn: arn:aws:iam::123456789012:role/example-role
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  microsoftSqlServerSettings:
    bcpPacketSize: 2
    controlTablesFileGroup: example
    databaseName: example-dmsendpoint
    forceLobLookup: false
    password: example
    port: 443
    querySingleAlwaysOnNode: false
    readBackupOnly: false
    safeguardPolicy: example
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    serverName: example-dmsendpoint
    tlogAccessMode: example
    trimSpaceInChar: false
    useBcpFullLoad: false
    useThirdPartyBackupDevice: false
    username: example-dmsendpoint
  mongoDbSettings:
    authMechanism: example
    authSource: example
    authType: example
    databaseName: example-dmsendpoint
    docsToInvestigate: example
    nestingLevel: example
    password: example
    port: 443
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    serverName: example-dmsendpoint
    username: example-dmsendpoint
  mySqlSettings:
    afterConnectScript: example
    cleanSourceMetadataOnMismatch: false
    eventsPollInterval: 1
    maxFileSize: 2
    parallelLoadThreads: 1
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    serverTimezone: example
    targetDbType: example
  neptuneSettings:
    errorRetryDuration: 1
    iamAuthEnabled: true
    maxFileSize: 2
    maxRetryCount: 2
    s3BucketFolder: example
    s3BucketName: example-dmsendpoint
    serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  oracleSettings:
    accessAlternateDirectly: false
    addSupplementalLogging: false
    additionalArchivedLogDestId: 1
    allowSelectNestedTables: false
    archivedLogDestId: 1
    archivedLogsOnly: false
    asmPassword: example
    asmServer: example
    asmUser: example
    charLengthSemantics: example
    directPathNoLog: false
    directPathParallelLoad: false
    enableHomogenousTablespace: true
    extraArchivedLogDestIds:
    - 1
    failTasksOnLobTruncation: false
    numberDatatypeScale: 1
    oraclePathPrefix: example
    parallelAsmReadThreads: 1
    readAheadBlocks: 1
    readTableSpaceName: false
    replacePathPrefix: false
    retryInterval: 1
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    secretsManagerOracleAsmAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    securityDbEncryption: example
    securityDbEncryptionName: example-dmsendpoint
    spatialDataOptionToGeoJsonFunctionName: example-dmsendpoint
    standbyDelayTime: 1
    useAlternateFolderForOnline: false
    useBFile: false
    useDirectPathFullLoad: false
    useLogminerReader: false
    usePathPrefix: example
  password: example
  port: 443
  postgreSqlSettings:
    afterConnectScript: example
    babelfishDatabaseName: example-dmsendpoint
    captureDdls: false
    databaseMode: example
    ddlArtifactsSchema: example
    executeTimeout: 300
    failTasksOnLobTruncation: false
    heartbeatEnable: true
    heartbeatFrequency: 1
    heartbeatSchema: example
    mapBooleanAsBoolean: false
    maxFileSize: 2
    pluginName: example-dmsendpoint
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    slotName: example-dmsendpoint
  providerRef:
    name: example-dmsendpoint
    region: us-east-1
  redisSettings:
    authPassword: example
    authType: example
    authUserName: example-dmsendpoint
    port: 443
    serverName: example-dmsendpoint
    sslCaCertificateArn: arn:aws:iam::123456789012:role/example-role
    sslSecurityProtocol: example
  redshiftSettings:
    acceptAnyDate: false
    afterConnectScript: example
    bucketFolder: example
    bucketName: example-dmsendpoint
    caseSensitiveNames: false
    compUpdate: false
    connectionTimeout: 300
    dateFormat: example
    emptyAsNull: false
    encryptionMode: example
    explicitIds: false
    fileTransferUploadStreams: 1
    loadTimeout: 300
    mapBooleanAsBoolean: false
    maxFileSize: 2
    removeQuotes: false
    replaceChars: example
    replaceInvalidChars: example
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    serverSideEncryptionKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
    serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    timeFormat: '2026-01-01T00:00:00Z'
    trimBlanks: false
    truncateColumns: false
    writeBufferSize: 2
  resourceIdentifier: example
  s3Settings:
    addColumnName: false
    addTrailingPaddingCharacter: false
    bucketFolder: example
    bucketName: example-dmsendpoint
    cannedAclForObjects: example
    cdcInsertsAndUpdates: false
    cdcInsertsOnly: false
    cdcMaxBatchInterval: 1
    cdcMinFileSize: 2
    cdcPath: example
    compressionType: example
    csvDelimiter: example
    csvNoSupValue: example
    csvNullValue: example
    csvRowDelimiter: example
    dataFormat: example
    dataPageSize: 2
    datePartitionDelimiter: example
    datePartitionEnabled: true
    datePartitionSequence: example
    datePartitionTimezone: example
    dictPageSizeLimit: 2
    enableStatistics: true
    encodingType: example
    encryptionMode: example
    expectedBucketOwner: example
    externalTableDefinition: example
    glueCatalogGeneration: false
    ignoreHeaderRows: 1
    includeOpForFullLoad: false
    maxFileSize: 2
    parquetTimestampInMillisecond: false
    parquetVersion: '1.0'
    preserveTransactions: false
    rfc4180: false
    rowGroupLength: 1
    serverSideEncryptionKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
    serviceAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    timestampColumnName: example-dmsendpoint
    useCsvNoSupValue: false
    useTaskStartTimeForFullLoadTimestamp: false
  serverName: example-dmsendpoint
  sslMode: example
  sybaseSettings:
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  username: example-dmsendpoint

Spec

Field	Type	Required	Description
`certificateArn`	string	—	The Amazon Resource Name (ARN) for the certificate.
`databaseName`	string	—	The name of the endpoint database.
`docDbSettings`	object	—	Settings in JSON format for the source and target DocumentDB endpoint
`docDbSettings.docsToInvestigate`	integer	—	Indicates the number of documents to preview to determine the document organization.
`docDbSettings.extractDocId`	boolean	—	Specifies the document ID.
`docDbSettings.nestingLevel`	string	—	Specifies either document or table mode.
`docDbSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`docDbSettings.secretsManagerSecretId`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`dynamoDbSettings`	object	—	Settings in JSON format for the target Amazon DynamoDB endpoint
`dynamoDbSettings.serviceAccessRoleArn`	string	—	The Amazon Resource Name (ARN) used by the service to access the IAM role.
`elasticsearchSettings`	object	—	Settings in JSON format for the target OpenSearch endpoint
`elasticsearchSettings.endpointUri`	string	—	The endpoint for the OpenSearch cluster.
`elasticsearchSettings.errorRetryDuration`	integer	—	The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
`elasticsearchSettings.fullLoadErrorPercentage`	integer	—	The maximum percentage of records that can fail to be written before a full load operation stops.
`elasticsearchSettings.serviceAccessRoleArn`	string	—	The Amazon Resource Name (ARN) used by the service to access the IAM role.
`endpointIdentifier`	string	—	The database endpoint identifier.
`endpointType`	string	yes	The type of endpoint.
`engineName`	string	yes	The type of engine for the endpoint, depending on the EndpointType value.
`extraConnectionAttributes`	string	—	Additional attributes associated with the connection
`gcpMySQLSettings`	object	—	Settings in JSON format for the source GCP MySQL endpoint
`gcpMySQLSettings.afterConnectScript`	string	—	Specifies a script to run immediately after AWS DMS connects to the endpoint.
`gcpMySQLSettings.cleanSourceMetadataOnMismatch`	boolean	—	Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.
`gcpMySQLSettings.databaseName`	string	—	Database name for the endpoint.
`gcpMySQLSettings.eventsPollInterval`	integer	—	Specifies how often to check the binary log for new changes/events when the database is idle.
`gcpMySQLSettings.maxFileSize`	integer	—	Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
`gcpMySQLSettings.parallelLoadThreads`	integer	—	Improves performance when loading data into the MySQL-compatible target database.
`gcpMySQLSettings.password`	string	—	Endpoint connection password.
`gcpMySQLSettings.port`	integer	—	The port used by the endpoint database.
`gcpMySQLSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`gcpMySQLSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
`gcpMySQLSettings.serverName`	string	—	The MySQL host name.
`gcpMySQLSettings.serverTimezone`	string	—	Specifies the time zone for the source MySQL database.
`gcpMySQLSettings.username`	string	—	Specifies the time zone for the source MySQL database.
`ibmDb2Settings`	object	—	Settings in JSON format for the source IBM Db2 LUW endpoint
`ibmDb2Settings.currentLsn`	string	—	For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
`ibmDb2Settings.keepCsvFiles`	boolean	—	If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data.
`ibmDb2Settings.loadTimeout`	integer	—	The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target.
`ibmDb2Settings.maxFileSize`	integer	—	Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
`ibmDb2Settings.maxKBytesPerRead`	integer	—	Maximum number of bytes per read, as a NUMBER value.
`ibmDb2Settings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`ibmDb2Settings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
`ibmDb2Settings.setDataCaptureChanges`	boolean	—	Enables ongoing replication (CDC) as a BOOLEAN value.
`ibmDb2Settings.writeBufferSize`	integer	—	The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance.
`kafkaSettings`	object	—	Settings in JSON format for the target Apache Kafka endpoint
`kafkaSettings.broker`	string	—	A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.
`kafkaSettings.includeControlDetails`	boolean	—	Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
`kafkaSettings.includeNullAndEmpty`	boolean	—	Include NULL and empty columns for records migrated to the endpoint.
`kafkaSettings.includePartitionValue`	boolean	—	Shows the partition value within the Kafka message output unless the partition type is schema-table-type.
`kafkaSettings.includeTableAlterOperations`	boolean	—	Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column.
`kafkaSettings.includeTransactionDetails`	boolean	—	Provides detailed transaction information from the source database.
`kafkaSettings.messageFormat`	string	—	The output format for the records created on the endpoint.
`kafkaSettings.messageMaxBytes`	integer	—	The maximum size in bytes for records created on the endpoint The default is 1,000,000.
`kafkaSettings.noHexPrefix`	boolean	—	Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
`kafkaSettings.partitionIncludeSchemaTable`	boolean	—	Prefixes schema and table names to partition values, when the partition type is primary-key-type.
`kafkaSettings.saslPassword`	string	—	The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`kafkaSettings.saslUserName`	string	—	The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`kafkaSettings.securityProtocol`	string	—	Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
`kafkaSettings.sslCaCertificateArn`	string	—	The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
`kafkaSettings.sslClientCertificateArn`	string	—	The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
`kafkaSettings.sslClientKeyArn`	string	—	The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
`kafkaSettings.sslClientKeyPassword`	string	—	The password for the client private key used to securely connect to a Kafka target endpoint.
`kafkaSettings.topic`	string	—	The topic to which you migrate the data.
`kinesisSettings`	object	—	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
`kinesisSettings.includeControlDetails`	boolean	—	Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
`kinesisSettings.includeNullAndEmpty`	boolean	—	Include NULL and empty columns for records migrated to the endpoint.
`kinesisSettings.includePartitionValue`	boolean	—	Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type.
`kinesisSettings.includeTableAlterOperations`	boolean	—	Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column.
`kinesisSettings.includeTransactionDetails`	boolean	—	Provides detailed transaction information from the source database.
`kinesisSettings.messageFormat`	string	—	The output format for the records created on the endpoint.
`kinesisSettings.noHexPrefix`	boolean	—	Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
`kinesisSettings.partitionIncludeSchemaTable`	boolean	—	Prefixes schema and table names to partition values, when the partition type is primary-key-type.
`kinesisSettings.serviceAccessRoleArn`	string	—	The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream.
`kinesisSettings.streamArn`	string	—	The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
`kmsKeyId`	string	—	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.If you don't specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.
`microsoftSqlServerSettings`	object	—	Settings in JSON format for the source and target Microsoft SQL Server endpoint
`microsoftSqlServerSettings.bcpPacketSize`	integer	—	The maximum size of the packets (in bytes) used to transfer data using BCP.
`microsoftSqlServerSettings.controlTablesFileGroup`	string	—	Specifies a file group for the AWS DMS internal tables.
`microsoftSqlServerSettings.databaseName`	string	—	Database name for the endpoint.
`microsoftSqlServerSettings.forceLobLookup`	boolean	—	Forces LOB lookup on inline LOB.
`microsoftSqlServerSettings.password`	string	—	Endpoint connection password.
`microsoftSqlServerSettings.port`	integer	—	Endpoint TCP port.
`microsoftSqlServerSettings.querySingleAlwaysOnNode`	boolean	—	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`microsoftSqlServerSettings.readBackupOnly`	boolean	—	When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
`microsoftSqlServerSettings.safeguardPolicy`	string	—	Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
`microsoftSqlServerSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
`microsoftSqlServerSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
`microsoftSqlServerSettings.serverName`	string	—	Fully qualified domain name of the endpoint.
`microsoftSqlServerSettings.tlogAccessMode`	string	—	Indicates the mode used to fetch CDC data.
`microsoftSqlServerSettings.trimSpaceInChar`	boolean	—	Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
`microsoftSqlServerSettings.useBcpFullLoad`	boolean	—	Use this to attribute to transfer data for full-load operations using BCP.
`microsoftSqlServerSettings.useThirdPartyBackupDevice`	boolean	—	When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
`microsoftSqlServerSettings.username`	string	—	Endpoint connection user name.
`mongoDbSettings`	object	—	Settings in JSON format for the source MongoDB endpoint
`mongoDbSettings.authMechanism`	string	—	The authentication mechanism you use to access the MongoDB source endpoint.
`mongoDbSettings.authSource`	string	—	The MongoDB database name.
`mongoDbSettings.authType`	string	—	The authentication type you use to access the MongoDB source endpoint.
`mongoDbSettings.databaseName`	string	—	The database name on the MongoDB source endpoint.
`mongoDbSettings.docsToInvestigate`	string	—	Indicates the number of documents to preview to determine the document organization.
`mongoDbSettings.extractDocId`	string	—	Specifies the document ID.
`mongoDbSettings.nestingLevel`	string	—	Specifies either document or table mode.
`mongoDbSettings.password`	string	—	The password for the user account you use to access the MongoDB source endpoint.
`mongoDbSettings.port`	integer	—	The port value for the MongoDB source endpoint.
`mongoDbSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
`mongoDbSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
`mongoDbSettings.serverName`	string	—	The name of the server on the MongoDB source endpoint.
`mongoDbSettings.username`	string	—	The user name you use to access the MongoDB source endpoint.
`mySqlSettings`	object	—	Settings in JSON format for the source and target MySQL endpoin
`mySqlSettings.afterConnectScript`	string	—	Specifies a script to run immediately after AWS DMS connects to the endpoint.
`mySqlSettings.cleanSourceMetadataOnMismatch`	boolean	—	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`mySqlSettings.eventsPollInterval`	integer	—	Specifies how often to check the binary log for new changes/events when the database is idle.
`mySqlSettings.maxFileSize`	integer	—	Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
`mySqlSettings.parallelLoadThreads`	integer	—	Improves performance when loading data into the MySQL-compatible target database.
`mySqlSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`mySqlSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
`mySqlSettings.serverTimezone`	string	—	Specifies the time zone for the source MySQL database.
`mySqlSettings.targetDbType`	string	—	Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`neptuneSettings`	object	—	Settings in JSON format for the target Amazon Neptune endpoint
`neptuneSettings.errorRetryDuration`	integer	—	The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error.
`neptuneSettings.iamAuthEnabled`	boolean	—	If you want IAM authorization enabled for this endpoint, set this parameter to true.
`neptuneSettings.maxFileSize`	integer	—	The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
`neptuneSettings.maxRetryCount`	integer	—	The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.
`neptuneSettings.s3BucketFolder`	string	—	A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
`neptuneSettings.s3BucketName`	string	—	The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
`neptuneSettings.serviceAccessRoleArn`	string	—	The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.
`oracleSettings`	object	—	Settings in JSON format for the source and target Oracle endpoint
`oracleSettings.accessAlternateDirectly`	boolean	—	Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
`oracleSettings.addSupplementalLogging`	boolean	—	Set this attribute to set up table-level supplemental logging for the Oracle database.
`oracleSettings.additionalArchivedLogDestId`	integer	—	Set this attribute with ArchivedLogDestId in a primary/ standby setup
`oracleSettings.allowSelectNestedTables`	boolean	—	Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
`oracleSettings.archivedLogDestId`	integer	—	Specifies the ID of the destination for the archived redo logs.
`oracleSettings.archivedLogsOnly`	boolean	—	When this field is set to True, AWS DMS only accesses the archived redo logs
`oracleSettings.asmPassword`	string	—	For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
`oracleSettings.asmServer`	string	—	For an Oracle source endpoint, your ASM server address.
`oracleSettings.asmUser`	string	—	For an Oracle source endpoint, your ASM user name.
`oracleSettings.charLengthSemantics`	string	—	Specifies whether the length of a character column is in bytes or in characters.
`oracleSettings.directPathNoLog`	boolean	—	When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.
`oracleSettings.directPathParallelLoad`	boolean	—	When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
`oracleSettings.enableHomogenousTablespace`	boolean	—	Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
`oracleSettings.extraArchivedLogDestIds`	array<integer>	—	Specifies the IDs of one more destinations for one or more archived redo logs.
`oracleSettings.failTasksOnLobTruncation`	boolean	—	When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.
`oracleSettings.numberDatatypeScale`	integer	—	Specifies the number scale.
`oracleSettings.oraclePathPrefix`	string	—	Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
`oracleSettings.parallelAsmReadThreads`	integer	—	Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).
`oracleSettings.readAheadBlocks`	integer	—	Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).
`oracleSettings.readTableSpaceName`	boolean	—	When set to true, this attribute supports tablespace replication.
`oracleSettings.replacePathPrefix`	boolean	—	Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
`oracleSettings.retryInterval`	integer	—	Specifies the number of seconds that the system waits before resending a query.
`oracleSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`oracleSettings.secretsManagerOracleAsmAccessRoleArn`	string	—	Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
`oracleSettings.secretsManagerOracleAsmSecretId`	string	—	Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
`oracleSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
`oracleSettings.securityDbEncryption`	string	—	For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader.
`oracleSettings.securityDbEncryptionName`	string	—	For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE.
`oracleSettings.spatialDataOptionToGeoJsonFunctionName`	string	—	Use this attribute to convert SDO_GEOMETRY to GEOJSON format.
`oracleSettings.standbyDelayTime`	integer	—	Use this attribute to specify a time in minutes for the delay in standby sync.
`oracleSettings.useAlternateFolderForOnline`	boolean	—	Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source
`oracleSettings.useBFile`	boolean	—	Set this attribute to True to capture change data using the Binary Reader utility.
`oracleSettings.useDirectPathFullLoad`	boolean	—	Set this attribute to True to have AWS DMS use a direct path full load.
`oracleSettings.useLogminerReader`	boolean	—	Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
`oracleSettings.usePathPrefix`	string	—	Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
`password`	string	—	The password to be used to log in to the endpoint database.
`port`	integer	—	The port used by the endpoint database.
`postgreSqlSettings`	object	—	Settings in JSON format for the source and target PostgreSQL endpoint.
`postgreSqlSettings.afterConnectScript`	string	—	For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
`postgreSqlSettings.babelfishDatabaseName`	string	—	The Babelfish for Aurora PostgreSQL database name for the endpoint.
`postgreSqlSettings.captureDdls`	boolean	—	To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
`postgreSqlSettings.databaseMode`	string	—	Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
`postgreSqlSettings.ddlArtifactsSchema`	string	—	The schema in which the operational DDL database artifacts are created.
`postgreSqlSettings.executeTimeout`	integer	—	Sets the client statement timeout for the PostgreSQL instance, in seconds.
`postgreSqlSettings.failTasksOnLobTruncation`	boolean	—	When set to true, this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize.
`postgreSqlSettings.heartbeatEnable`	boolean	—	The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
`postgreSqlSettings.heartbeatFrequency`	integer	—	Sets the WAL heartbeat frequency (in minutes).
`postgreSqlSettings.heartbeatSchema`	string	—	Sets the schema in which the heartbeat artifacts are created.
`postgreSqlSettings.mapBooleanAsBoolean`	boolean	—	When true, lets PostgreSQL migrate the boolean type as boolean.
`postgreSqlSettings.maxFileSize`	integer	—	Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
`postgreSqlSettings.pluginName`	string	—	Specifies the plugin to use to create a replication slot.
`postgreSqlSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`postgreSqlSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
`postgreSqlSettings.slotName`	string	—	Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`redisSettings`	object	—	Settings in JSON format for the target Redis endpoint
`redisSettings.authPassword`	string	—	The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
`redisSettings.authType`	string	—	The type of authentication to perform when connecting to a Redis target.
`redisSettings.authUserName`	string	—	The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
`redisSettings.port`	number	—	Transmission Control Protocol (TCP) port for the endpoint.
`redisSettings.serverName`	string	—	Fully qualified domain name of the endpoint.
`redisSettings.sslCaCertificateArn`	string	—	The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
`redisSettings.sslSecurityProtocol`	string	—	The connection to a Redis target endpoint using Transport Layer Security (TLS).
`redshiftSettings`	object	—	Settings in JSON format for the Amazon Redshift endpoint.
`redshiftSettings.acceptAnyDate`	boolean	—	A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.
`redshiftSettings.afterConnectScript`	string	—	Code to run after connecting.
`redshiftSettings.bucketFolder`	string	—	An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
`redshiftSettings.bucketName`	string	—	The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
`redshiftSettings.caseSensitiveNames`	boolean	—	If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true.
`redshiftSettings.compUpdate`	boolean	—	If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
`redshiftSettings.connectionTimeout`	integer	—	A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
`redshiftSettings.dateFormat`	string	—	The date format that you are using.
`redshiftSettings.emptyAsNull`	boolean	—	A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
`redshiftSettings.encryptionMode`	string	—	The type of server-side encryption that you want to use for your data.
`redshiftSettings.explicitIds`	boolean	—	This setting is only valid for a full-load migration task.
`redshiftSettings.fileTransferUploadStreams`	integer	—	The number of threads used to upload a single file.
`redshiftSettings.loadTimeout`	integer	—	The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
`redshiftSettings.mapBooleanAsBoolean`	boolean	—	When true, lets Redshift migrate the boolean type as boolean.
`redshiftSettings.maxFileSize`	integer	—	The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift.
`redshiftSettings.removeQuotes`	boolean	—	A value that specifies to remove surrounding quotation marks from strings in the incoming data.
`redshiftSettings.replaceChars`	string	—	A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead.
`redshiftSettings.replaceInvalidChars`	string	—	A list of characters that you want to replace.
`redshiftSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
`redshiftSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
`redshiftSettings.serverSideEncryptionKmsKeyId`	string	—	The AWS KMS key ID.
`redshiftSettings.serviceAccessRoleArn`	string	—	The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
`redshiftSettings.timeFormat`	string	—	The time format that you want to use.
`redshiftSettings.trimBlanks`	boolean	—	A value that specifies to remove the trailing white space characters from a VARCHAR string.
`redshiftSettings.truncateColumns`	boolean	—	A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
`redshiftSettings.writeBufferSize`	integer	—	The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance.
`resourceIdentifier`	string	—	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
`s3Settings`	object	—	Settings in JSON format for the source and target Amazon S3 endpoint
`s3Settings.addColumnName`	boolean	—	An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
`s3Settings.addTrailingPaddingCharacter`	boolean	—	Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data.
`s3Settings.bucketFolder`	string	—	An optional parameter to set a folder name in the S3 bucket.
`s3Settings.bucketName`	string	—	The name of the S3 bucket.
`s3Settings.cannedAclForObjects`	string	—	A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
`s3Settings.cdcInsertsAndUpdates`	boolean	—	A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
`s3Settings.cdcInsertsOnly`	boolean	—	A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files.
`s3Settings.cdcMaxBatchInterval`	integer	—	Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
`s3Settings.cdcMinFileSize`	integer	—	Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
`s3Settings.cdcPath`	string	—	Specifies the folder path of CDC files.
`s3Settings.compressionType`	string	—	An optional parameter.
`s3Settings.csvDelimiter`	string	—	The delimiter used to separate columns in the .csv file for both source and target.
`s3Settings.csvNoSupValue`	string	—	This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
`s3Settings.csvNullValue`	string	—	An optional parameter that specifies how AWS DMS treats null values.
`s3Settings.csvRowDelimiter`	string	—	The delimiter used to separate rows in the .csv file for both source and target.
`s3Settings.dataFormat`	string	—	The format of the data that you want to use for output.
`s3Settings.dataPageSize`	integer	—	The size of one data page in bytes.
`s3Settings.datePartitionDelimiter`	string	—	Specifies a date separating delimiter to use during folder partitioning.
`s3Settings.datePartitionEnabled`	boolean	—	When set to true, this parameter partitions S3 bucket folders based on transaction commit dates.
`s3Settings.datePartitionSequence`	string	—	Identifies the sequence of the date format to use during folder partitioning.
`s3Settings.datePartitionTimezone`	string	—	When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
`s3Settings.dictPageSizeLimit`	integer	—	The maximum size of an encoded dictionary page of a column
`s3Settings.enableStatistics`	boolean	—	A value that enables statistics for Parquet pages and row groups.
`s3Settings.encodingType`	string	—	The type of encoding that you're using.
`s3Settings.encryptionMode`	string	—	The type of server-side encryption that you want to use for your data.
`s3Settings.expectedBucketOwner`	string	—	To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
`s3Settings.externalTableDefinition`	string	—	The external table definition.
`s3Settings.glueCatalogGeneration`	boolean	—	When true, allows AWS Glue to catalog your S3 bucket.
`s3Settings.ignoreHeaderRows`	integer	—	When this value is set to 1, AWS DMS ignores the first row header in a .csv file.
`s3Settings.includeOpForFullLoad`	boolean	—	A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
`s3Settings.maxFileSize`	integer	—	A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.
`s3Settings.parquetTimestampInMillisecond`	boolean	—	A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
`s3Settings.parquetVersion`	string	—	The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
`s3Settings.preserveTransactions`	boolean	—	If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
`s3Settings.rfc4180`	boolean	—	For an S3 source, when this value is set to true or y, each leading double quotation mark has to be followed by an ending double quotation mark.
`s3Settings.rowGroupLength`	integer	—	The number of rows in a row group.
`s3Settings.serverSideEncryptionKmsKeyId`	string	—	If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID.
`s3Settings.serviceAccessRoleArn`	string	—	A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
`s3Settings.timestampColumnName`	string	—	A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
`s3Settings.useCsvNoSupValue`	boolean	—	This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format.
`s3Settings.useTaskStartTimeForFullLoadTimestamp`	boolean	—	When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target
`serverName`	string	—	The name of the server where the endpoint database resides.
`sslMode`	string	—	The Secure Sockets Layer (SSL) mode to use for the SSL connection.
`sybaseSettings`	object	—	Settings in JSON format for the source and target SAP ASE endpoint.
`sybaseSettings.secretsManagerAccessRoleArn`	string	—	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
`sybaseSettings.secretsManagerSecretId`	string	—	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
`tags`	array<object>	—	One or more tags to be assigned to the endpoint.
`tags[].key`	string	yes
`tags[].value`	string	yes
`username`	string	—	The user name to be used to log in to the endpoint database.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`endpointArn`	string	—	The endpoint ARN.
`externalId`	string	—	A value that can be used for cross-account validation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSEventSubscription # CLOUD CONTROL · AWS::DMS::EventSubscription

DMSEventSubscription manages AWS::DMS::EventSubscription through the AWS Cloud Control API.

kubectl get dmseventsubscriptions · example on GitHub

Example

# DMSEventSubscription — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmseventsubscription
apiVersion: aws.konfig.io/v1alpha1
kind: DMSEventSubscription
metadata:
  name: example-dmseventsubscription
  namespace: default
spec:
  enabled: true
  eventCategories:
  - example
  providerRef:
    name: example-dmseventsubscription
    region: us-east-1
  snsTopicArn: arn:aws:iam::123456789012:role/example-role
  sourceIds:
  - example
  sourceType: example
  subscriptionName: example-dmseventsubscription
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`enabled`	boolean	—	Indicates whether to activate the subscription.
`eventCategories`	array<string>	—	A list of event categories for a source type that you want to subscribe to.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`snsTopicArn`	string	yes	The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
`sourceIds`	array<string>	—	A list of identifiers for which AWS DMS provides notification events.
`sourceType`	string	—	The type of AWS DMS resource that generates the events.
`subscriptionName`	string	—	The name of the AWS DMS event notification subscription.
`tags`	array<object>	—	One or more tags to be assigned to the event subscription.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSInstanceProfile # CLOUD CONTROL · AWS::DMS::InstanceProfile

DMSInstanceProfile manages AWS::DMS::InstanceProfile through the AWS Cloud Control API.

kubectl get dmsinstanceprofiles · example on GitHub

Example

# DMSInstanceProfile — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsinstanceprofile
apiVersion: aws.konfig.io/v1alpha1
kind: DMSInstanceProfile
metadata:
  name: example-dmsinstanceprofile
  namespace: default
spec:
  availabilityZone: us-east-1a
  description: Managed by konfig-konector
  instanceProfileIdentifier: example
  instanceProfileName: example-dmsinstanceprofile
  kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  networkType: IPV4
  providerRef:
    name: example-dmsinstanceprofile
    region: us-east-1
  publiclyAccessible: false
  subnetGroupIdentifier: example
  tags:
  - key: example
    value: example
  vpcSecurityGroups:
  - example

Spec

Field	Type	Required	Description
`availabilityZone`	string	—	The property describes an availability zone of the instance profile.
`description`	string	—	The optional description of the instance profile.
`instanceProfileIdentifier`	string	—	The property describes an identifier for the instance profile.
`instanceProfileName`	string	—	The property describes a name for the instance profile.
`kmsKeyArn`	string	—	The property describes kms key arn for the instance profile.
`networkType`	enum	—	The property describes a network type for the instance profile. Allowed: `IPV4, DUAL`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`publiclyAccessible`	boolean	—	The property describes the publicly accessible of the instance profile
`subnetGroupIdentifier`	string	—	The property describes a subnet group identifier for the instance profile.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`vpcSecurityGroups`	array<string>	—	The property describes vps security groups for the instance profile.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`instanceProfileArn`	string	—	The property describes an ARN of the instance profile.
`instanceProfileCreationTime`	string	—	The property describes a creating time of the instance profile.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSMigrationProject # CLOUD CONTROL · AWS::DMS::MigrationProject

DMSMigrationProject manages AWS::DMS::MigrationProject through the AWS Cloud Control API.

kubectl get dmsmigrationprojects · example on GitHub

Example

# DMSMigrationProject — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsmigrationproject
apiVersion: aws.konfig.io/v1alpha1
kind: DMSMigrationProject
metadata:
  name: example-dmsmigrationproject
  namespace: default
spec:
  description: Managed by konfig-konector
  instanceProfileArn: arn:aws:iam::123456789012:role/example-role
  instanceProfileIdentifier: example
  instanceProfileName: example-dmsmigrationproject
  migrationProjectCreationTime: '2026-01-01T00:00:00Z'
  migrationProjectIdentifier: example
  migrationProjectName: example-dmsmigrationproject
  providerRef:
    name: example-dmsmigrationproject
    region: us-east-1
  schemaConversionApplicationAttributes:
    s3BucketPath: example
    s3BucketRoleArn: arn:aws:iam::123456789012:role/example-role
  sourceDataProviderDescriptors:
  - dataProviderArn: arn:aws:iam::123456789012:role/example-role
    dataProviderIdentifier: example
    dataProviderName: example-dmsmigrationproject
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  targetDataProviderDescriptors:
  - dataProviderArn: arn:aws:iam::123456789012:role/example-role
    dataProviderIdentifier: example
    dataProviderName: example-dmsmigrationproject
    secretsManagerAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  transformationRules: example

Spec

Field	Type	Required	Description
`description`	string	—	The optional description of the migration project.
`instanceProfileArn`	string	—	The property describes an instance profile arn for the migration project.
`instanceProfileIdentifier`	string	—	The property describes an instance profile identifier for the migration project.
`instanceProfileName`	string	—	The property describes an instance profile name for the migration project.
`migrationProjectCreationTime`	string	—	The property describes a creating time of the migration project.
`migrationProjectIdentifier`	string	—	The property describes an identifier for the migration project.
`migrationProjectName`	string	—	The property describes a name to identify the migration project.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`schemaConversionApplicationAttributes`	object	—	The property describes schema conversion application attributes for the migration project.
`schemaConversionApplicationAttributes.s3BucketPath`	string	—
`schemaConversionApplicationAttributes.s3BucketRoleArn`	string	—
`sourceDataProviderDescriptors`	array<object>	—	The property describes source data provider descriptors for the migration project.
`sourceDataProviderDescriptors[].dataProviderArn`	string	—
`sourceDataProviderDescriptors[].dataProviderIdentifier`	string	—
`sourceDataProviderDescriptors[].dataProviderName`	string	—
`sourceDataProviderDescriptors[].secretsManagerAccessRoleArn`	string	—
`sourceDataProviderDescriptors[].secretsManagerSecretId`	string	—
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`targetDataProviderDescriptors`	array<object>	—	The property describes target data provider descriptors for the migration project.
`targetDataProviderDescriptors[].dataProviderArn`	string	—
`targetDataProviderDescriptors[].dataProviderIdentifier`	string	—
`targetDataProviderDescriptors[].dataProviderName`	string	—
`targetDataProviderDescriptors[].secretsManagerAccessRoleArn`	string	—
`targetDataProviderDescriptors[].secretsManagerSecretId`	string	—
`transformationRules`	string	—	The property describes transformation rules for the migration project.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`migrationProjectArn`	string	—	The property describes an ARN of the migration project.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSReplicationConfig # CLOUD CONTROL · AWS::DMS::ReplicationConfig

DMSReplicationConfig manages AWS::DMS::ReplicationConfig through the AWS Cloud Control API.

kubectl get dmsreplicationconfigs · example on GitHub

Example

# DMSReplicationConfig — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsreplicationconfig
apiVersion: aws.konfig.io/v1alpha1
kind: DMSReplicationConfig
metadata:
  name: example-dmsreplicationconfig
  namespace: default
spec:
  computeConfig:
    availabilityZone: us-east-1a
    dnsNameServers: example
    kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
    maxCapacityUnits: 2
    minCapacityUnits: 2
    multiAZ: false
    preferredMaintenanceWindow: example
    vpcSecurityGroupIds:
    - example
  providerRef:
    name: example-dmsreplicationconfig
    region: us-east-1
  replicationConfigIdentifier: example
  replicationType: full-load
  resourceIdentifier: example
  sourceEndpointArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  targetEndpointArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`computeConfig`	object	yes	DMSReplicationConfigComputeConfig is a nested property type of AWS::DMS::ReplicationConfig.
`computeConfig.availabilityZone`	string	—
`computeConfig.dnsNameServers`	string	—
`computeConfig.kmsKeyId`	string	—
`computeConfig.maxCapacityUnits`	integer	yes
`computeConfig.minCapacityUnits`	integer	—
`computeConfig.multiAZ`	boolean	—
`computeConfig.preferredMaintenanceWindow`	string	—
`computeConfig.replicationSubnetGroupId`	string	—
`computeConfig.vpcSecurityGroupIds`	array<string>	—
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`replicationConfigIdentifier`	string	yes	A unique identifier of replication configuration
`replicationSettings`	object	—	JSON settings for Servereless replications that are provisioned using this replication configuration
`replicationType`	enum	yes	The type of AWS DMS Serverless replication to provision using this replication configuration Allowed: `full-load, full-load-and-cdc, cdc`
`resourceIdentifier`	string	—	A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource Create-only in AWS: changing it requires replacing the resource.
`sourceEndpointArn`	string	yes	The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
`supplementalSettings`	object	—	JSON settings for specifying supplemental data
`tableMappings`	object	yes	JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
`tags`	array<object>	—	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
`tags[].key`	string	yes
`tags[].value`	string	yes
`targetEndpointArn`	string	yes	The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`replicationConfigArn`	string	—	The Amazon Resource Name (ARN) of the Replication Config Read-only: reported by AWS after creation.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSReplicationSubnetGroup # CLOUD CONTROL · AWS::DMS::ReplicationSubnetGroup

DMSReplicationSubnetGroup manages AWS::DMS::ReplicationSubnetGroup through the AWS Cloud Control API.

kubectl get dmsreplicationsubnetgroups · example on GitHub

Example

# DMSReplicationSubnetGroup — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsreplicationsubnetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: DMSReplicationSubnetGroup
metadata:
  name: example-dmsreplicationsubnetgroup
  namespace: default
spec:
  providerRef:
    name: example-dmsreplicationsubnetgroup
    region: us-east-1
  replicationSubnetGroupDescription: Managed by konfig-konector
  replicationSubnetGroupIdentifier: example
  subnetIds:
  - example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`replicationSubnetGroupDescription`	string	yes	The description for the subnet group.
`replicationSubnetGroupIdentifier`	string	—	The name for the replication subnet group.
`subnetIds`	array<string>	yes	One or more subnet IDs to be assigned to the replication subnet group.
`tags`	array<object>	—	One or more tags to be assigned to the replication subnet group
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DMSReplicationTask # CLOUD CONTROL · AWS::DMS::ReplicationTask

DMSReplicationTask manages AWS::DMS::ReplicationTask through the AWS Cloud Control API.

kubectl get dmsreplicationtasks · example on GitHub

Example

# DMSReplicationTask — DMS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/dms.html#dmsreplicationtask
apiVersion: aws.konfig.io/v1alpha1
kind: DMSReplicationTask
metadata:
  name: example-dmsreplicationtask
  namespace: default
spec:
  cdcStartPosition: example
  cdcStartTime: 1
  cdcStopPosition: example
  migrationType: full-load
  providerRef:
    name: example-dmsreplicationtask
    region: us-east-1
  replicationInstanceArn: arn:aws:iam::123456789012:role/example-role
  replicationTaskIdentifier: example
  replicationTaskSettings: example
  resourceIdentifier: example
  sourceEndpointArn: arn:aws:iam::123456789012:role/example-role
  tableMappings: example
  tags:
  - key: example
    value: example
  targetEndpointArn: arn:aws:iam::123456789012:role/example-role
  taskData: example

Spec

Field	Type	Required	Description
`cdcStartPosition`	string	—	Indicates when you want a change data capture (CDC) operation to start.
`cdcStartTime`	number	—	Indicates the start time for a change data capture (CDC) operation.
`cdcStopPosition`	string	—	Indicates when you want a change data capture (CDC) operation to stop.
`migrationType`	enum	yes	The migration type. Allowed: `full-load, cdc, full-load-and-cdc`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`replicationInstanceArn`	string	yes	The Amazon Resource Name (ARN) of a replication instance.
`replicationTaskIdentifier`	string	—	An identifier for the replication task.
`replicationTaskSettings`	string	—	Overall settings for the task, in JSON format
`resourceIdentifier`	string	—	A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
`sourceEndpointArn`	string	yes	An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
`tableMappings`	string	yes	The table mappings for the task, in JSON format.
`tags`	array<object>	—
`tags[].key`	string	yes
`tags[].value`	string	yes
`targetEndpointArn`	string	yes	An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
`taskData`	string	—	Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`replicationTaskArn`	string	—	The ARN of the ReplicationTask.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.