Aws/dms
@swamp/aws/dmsv2026.09.15.1
01README
AWS DMS infrastructure models
02Models
certificate.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| CertificateIdentifier? | string | The certificate Identifier |
| CertificatePem? | string | The certificate Pem |
| CertificateWallet? | string | The certificate Wallet |
fn create()
Create a DMS Certificate
fn get(identifier: string)
Get a DMS Certificate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS Certificate |
fn delete(identifier: string)
Delete a DMS Certificate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS Certificate |
fn sync()
Sync DMS Certificate state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS Certificate resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS Certificate resource state
data_migration.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DataMigrationName? | string | The property describes a name to identify the data migration. |
| DataMigrationIdentifier? | string | The property describes an ARN of the data migration. |
| ServiceAccessRoleArn | string | The property describes Amazon Resource Name (ARN) of the service access role. |
| MigrationProjectIdentifier | string | The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn |
| DataMigrationType | enum | The property describes the type of migration. |
| DataMigrationSettings? | object | The property specifies whether to enable the CloudWatch log. |
| SourceDataSettings? | array | The property describes the settings for the data migration. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a DMS DataMigration
fn get(identifier: string)
Get a DMS DataMigration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS DataMigration |
fn update()
Update a DMS DataMigration
fn delete(identifier: string)
Delete a DMS DataMigration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS DataMigration |
fn sync()
Sync DMS DataMigration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS DataMigration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS DataMigration resource state
data_provider.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DataProviderName? | string | The property describes a name to identify the data provider. |
| DataProviderIdentifier? | string | The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn |
| Description? | string | The optional description of the data provider. |
| Engine | enum | The property describes a data engine for the data provider. |
| ExactSettings? | boolean | The property describes the exact settings which can be modified |
| Settings? | object | PostgreSqlSettings property identifier. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a DMS DataProvider
fn get(identifier: string)
Get a DMS DataProvider
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS DataProvider |
fn update()
Update a DMS DataProvider
fn delete(identifier: string)
Delete a DMS DataProvider
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS DataProvider |
fn sync()
Sync DMS DataProvider state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS DataProvider resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS DataProvider resource state
endpoint.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| CertificateArn? | string | The Amazon Resource Name (ARN) for the certificate. |
| DatabaseName? | string | The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType. |
| DocDbSettings? | object | Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one". |
| DynamoDbSettings? | object | The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action. |
| ElasticsearchSettings? | object | The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified. |
| EndpointIdentifier? | string | The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens. |
| EndpointType | string | The type of endpoint. Valid values are source and target. |
| EngineName | string | The type of engine for the endpoint, depending on the EndpointType value. |
| ExtraConnectionAttributes? | string | Additional attributes associated with the connection |
| GcpMySQLSettings? | object | Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails. |
| IbmDb2Settings? | object | For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start. |
| KafkaSettings? | object | A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port |
| KinesisSettings? | object | Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false. |
| 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 | The maximum size of the packets (in bytes) used to transfer data using BCP. |
| MongoDbSettings? | object | The authentication mechanism you use to access the MongoDB source endpoint. |
| MySqlSettings? | object | Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails. |
| NeptuneSettings? | object | 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. The default is 250. |
| OracleSettings? | object | 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. |
| Password? | string | The password to be used to log in to the endpoint database. |
| Port? | number | The port used by the endpoint database. |
| PostgreSqlSettings? | object | 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. |
| RedisSettings? | object | The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint. |
| RedshiftSettings? | object | 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. You can choose true or false (the default). |
| 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 | An optional parameter that, when set to true or y, you can use to add column name information to the.csv output file. |
| 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. The default is none. |
| SybaseSettings? | object | 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 |
| Tags? | array | One or more tags to be assigned to the endpoint. |
| Username? | string | The user name to be used to log in to the endpoint database. |
fn create()
Create a DMS Endpoint
fn get(identifier: string)
Get a DMS Endpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS Endpoint |
fn update()
Update a DMS Endpoint
fn delete(identifier: string)
Delete a DMS Endpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS Endpoint |
fn sync()
Sync DMS Endpoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS Endpoint resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS Endpoint resource state
event_subscription.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| SourceType? | string | The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value isn't specified, all events are returned. |
| EventCategories? | array | A list of event categories for a source type that you want to subscribe to. If you don't specify this property, you are notified about all event categories. |
| Enabled? | boolean | Indicates whether to activate the subscription. If you don't specify this property, CloudFormation activates the subscription. |
| SubscriptionName? | string | The name of the AWS DMS event notification subscription. This name must be less than 255 characters. |
| SnsTopicArn | string | The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. |
| SourceIds? | array | A list of identifiers for which AWS DMS provides notification events. If you don't specify a value, notifications are provided for all sources. If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs. |
| Tags? | array | One or more tags to be assigned to the event subscription. |
fn create()
Create a DMS EventSubscription
fn get(identifier: string)
Get a DMS EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS EventSubscription |
fn update()
Update a DMS EventSubscription
fn delete(identifier: string)
Delete a DMS EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS EventSubscription |
fn sync()
Sync DMS EventSubscription state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS EventSubscription resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS EventSubscription resource state
instance_profile.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| InstanceProfileIdentifier? | string | The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn |
| AvailabilityZone? | string | The property describes an availability zone of the instance profile. |
| Description? | string | The optional description of the instance profile. |
| KmsKeyArn? | string | The property describes kms key arn for the instance profile. |
| PubliclyAccessible? | boolean | The property describes the publicly accessible of the instance profile |
| NetworkType? | enum | The property describes a network type for the instance profile. |
| InstanceProfileName? | string | The property describes a name for the instance profile. |
| SubnetGroupIdentifier? | string | The property describes a subnet group identifier for the instance profile. |
| VpcSecurityGroups? | array | The property describes vps security groups for the instance profile. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a DMS InstanceProfile
fn get(identifier: string)
Get a DMS InstanceProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS InstanceProfile |
fn update()
Update a DMS InstanceProfile
fn delete(identifier: string)
Delete a DMS InstanceProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS InstanceProfile |
fn sync()
Sync DMS InstanceProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS InstanceProfile resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS InstanceProfile resource state
migration_project.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| MigrationProjectName? | string | The property describes a name to identify the migration project. |
| MigrationProjectIdentifier? | string | The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn |
| MigrationProjectCreationTime? | string | The property describes a creating time of the migration project. |
| InstanceProfileIdentifier? | string | The property describes an instance profile identifier for the migration project. For create |
| InstanceProfileName? | string | The property describes an instance profile name for the migration project. For read |
| InstanceProfileArn? | string | The property describes an instance profile arn for the migration project. For read |
| TransformationRules? | string | The property describes transformation rules for the migration project. |
| Description? | string | The optional description of the migration project. |
| SchemaConversionApplicationAttributes? | object | The property describes schema conversion application attributes for the migration project. |
| SourceDataProviderDescriptors? | array | The property describes source data provider descriptors for the migration project. |
| TargetDataProviderDescriptors? | array | The property describes target data provider descriptors for the migration project. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a DMS MigrationProject
fn get(identifier: string)
Get a DMS MigrationProject
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS MigrationProject |
fn update()
Update a DMS MigrationProject
fn delete(identifier: string)
Delete a DMS MigrationProject
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS MigrationProject |
fn sync()
Sync DMS MigrationProject state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS MigrationProject resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS MigrationProject resource state
replication_config.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ReplicationConfigIdentifier | string | A unique identifier of replication configuration |
| SourceEndpointArn | string | The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration |
| TargetEndpointArn | string | The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration |
| ReplicationType | enum | The type of AWS DMS Serverless replication to provision using this replication configuration |
| ComputeConfig? | object | Configuration parameters for provisioning a AWS DMS Serverless replication |
| ReplicationSettings? | record | JSON settings for Servereless replications that are provisioned using this replication configuration |
| SupplementalSettings? | record | JSON settings for specifying supplemental data |
| 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 |
| TableMappings | record | JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration |
| Tags? | array | Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. |
fn create()
Create a DMS ReplicationConfig
fn get(identifier: string)
Get a DMS ReplicationConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS ReplicationConfig |
fn update()
Update a DMS ReplicationConfig
fn delete(identifier: string)
Delete a DMS ReplicationConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS ReplicationConfig |
fn sync()
Sync DMS ReplicationConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS ReplicationConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS ReplicationConfig resource state
replication_subnet_group.tsv2026.08.17.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ReplicationSubnetGroupDescription | string | The description for the subnet group. |
| ReplicationSubnetGroupIdentifier? | string | The name for the replication subnet group. This value is stored as a lowercase string. |
| SubnetIds | array | One or more subnet IDs to be assigned to the replication subnet group. |
| Tags? | array | One or more tags to be assigned to the replication subnet group |
fn create()
Create a DMS ReplicationSubnetGroup
fn get(identifier: string)
Get a DMS ReplicationSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS ReplicationSubnetGroup |
fn update()
Update a DMS ReplicationSubnetGroup
fn delete(identifier: string)
Delete a DMS ReplicationSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS ReplicationSubnetGroup |
fn sync()
Sync DMS ReplicationSubnetGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS ReplicationSubnetGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS ReplicationSubnetGroup resource state
replication_task.tsv2026.09.03.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ReplicationTaskSettings? | string | Overall settings for the task, in JSON format |
| CdcStartTime? | number | Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. |
| CdcStartPosition? | string | Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. |
| CdcStopPosition? | string | Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. |
| MigrationType | enum | The migration type. |
| TargetEndpointArn | string | An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. |
| ReplicationInstanceArn | string | The Amazon Resource Name (ARN) of a replication instance. |
| TaskData? | string | Supplemental information that the task requires to migrate the data for certain source and target endpoints. |
| 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. |
| TableMappings | string | The table mappings for the task, in JSON format. |
| ReplicationTaskIdentifier? | string | An identifier for the replication task. |
| SourceEndpointArn | string | An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. |
| Tags? | array |
fn create()
Create a DMS ReplicationTask
fn get(identifier: string)
Get a DMS ReplicationTask
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS ReplicationTask |
fn update()
Update a DMS ReplicationTask
fn delete(identifier: string)
Delete a DMS ReplicationTask
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DMS ReplicationTask |
fn sync()
Sync DMS ReplicationTask state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DMS ReplicationTask resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DMS ReplicationTask resource state
03Previous Versions
2026.09.14.1
Modified 1 models
2026.09.13.1
2026.09.12.1
2026.09.11.1
2026.09.10.1
2026.09.09.1
2026.09.08.1
2026.09.07.1
2026.09.06.3
2026.09.06.1
2026.09.05.1
2026.09.04.1
2026.09.03.1
- Added: replication_task
2026.09.02.1
2026.09.01.1
2026.08.31.1
2026.08.30.1
2026.08.29.1
2026.08.28.1
04Stats
A
100 / 100
Downloads
0
Archive size
2.5 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels