dms_replication_task.md

permalink
/dms_replication_task/

dms_replication_task

dms_replication_task represents the aws_dms_replication_task Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withCdcStartPosition()
• fn withCdcStartTime()
• fn withMigrationType()
• fn withReplicationInstanceArn()
• fn withReplicationTaskId()
• fn withReplicationTaskSettings()
• fn withSourceEndpointArn()
• fn withStartReplicationTask()
• fn withTableMappings()
• fn withTags()
• fn withTagsAll()
• fn withTargetEndpointArn()

Fields

fn new

new()

aws.dms_replication_task.new injects a new aws_dms_replication_task Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.dms_replication_task.new('some_id')

You can get the reference to the id field of the created aws.dms_replication_task using the reference:

$._ref.aws_dms_replication_task.some_id.get('id')

This is the same as directly entering "${ aws_dms_replication_task.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• cdc_start_position (string): Set the cdc_start_position field on the resulting resource block. When null, the cdc_start_position field will be omitted from the resulting object.
• cdc_start_time (string): Set the cdc_start_time field on the resulting resource block. When null, the cdc_start_time field will be omitted from the resulting object.
• migration_type (string): Set the migration_type field on the resulting resource block.
• replication_instance_arn (string): Set the replication_instance_arn field on the resulting resource block.
• replication_task_id (string): Set the replication_task_id field on the resulting resource block.
• replication_task_settings (string): Set the replication_task_settings field on the resulting resource block. When null, the replication_task_settings field will be omitted from the resulting object.
• source_endpoint_arn (string): Set the source_endpoint_arn field on the resulting resource block.
• start_replication_task (bool): Set the start_replication_task field on the resulting resource block. When null, the start_replication_task field will be omitted from the resulting object.
• table_mappings (string): Set the table_mappings field on the resulting resource block.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
• target_endpoint_arn (string): Set the target_endpoint_arn field on the resulting resource block.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.dms_replication_task.newAttrs constructs a new object with attributes and blocks configured for the dms_replication_task Terraform resource.

Unlike aws.dms_replication_task.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• cdc_start_position (string): Set the cdc_start_position field on the resulting object. When null, the cdc_start_position field will be omitted from the resulting object.
• cdc_start_time (string): Set the cdc_start_time field on the resulting object. When null, the cdc_start_time field will be omitted from the resulting object.
• migration_type (string): Set the migration_type field on the resulting object.
• replication_instance_arn (string): Set the replication_instance_arn field on the resulting object.
• replication_task_id (string): Set the replication_task_id field on the resulting object.
• replication_task_settings (string): Set the replication_task_settings field on the resulting object. When null, the replication_task_settings field will be omitted from the resulting object.
• source_endpoint_arn (string): Set the source_endpoint_arn field on the resulting object.
• start_replication_task (bool): Set the start_replication_task field on the resulting object. When null, the start_replication_task field will be omitted from the resulting object.
• table_mappings (string): Set the table_mappings field on the resulting object.
• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
• target_endpoint_arn (string): Set the target_endpoint_arn field on the resulting object.

Returns:

• An attribute object that can be used with tf.withResource to construct a new dms_replication_task resource into the root Terraform configuration.

fn withCdcStartPosition

withCdcStartPosition()

aws.string.withCdcStartPosition constructs a mixin object that can be merged into the string Terraform resource block to set or update the cdc_start_position field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the cdc_start_position field.

fn withCdcStartTime

withCdcStartTime()

aws.string.withCdcStartTime constructs a mixin object that can be merged into the string Terraform resource block to set or update the cdc_start_time field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the cdc_start_time field.

fn withMigrationType

withMigrationType()

aws.string.withMigrationType constructs a mixin object that can be merged into the string Terraform resource block to set or update the migration_type field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the migration_type field.

fn withReplicationInstanceArn

withReplicationInstanceArn()

aws.string.withReplicationInstanceArn constructs a mixin object that can be merged into the string Terraform resource block to set or update the replication_instance_arn field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the replication_instance_arn field.

fn withReplicationTaskId

withReplicationTaskId()

aws.string.withReplicationTaskId constructs a mixin object that can be merged into the string Terraform resource block to set or update the replication_task_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the replication_task_id field.

fn withReplicationTaskSettings

withReplicationTaskSettings()

aws.string.withReplicationTaskSettings constructs a mixin object that can be merged into the string Terraform resource block to set or update the replication_task_settings field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the replication_task_settings field.

fn withSourceEndpointArn

withSourceEndpointArn()

aws.string.withSourceEndpointArn constructs a mixin object that can be merged into the string Terraform resource block to set or update the source_endpoint_arn field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the source_endpoint_arn field.

fn withStartReplicationTask

withStartReplicationTask()

aws.bool.withStartReplicationTask constructs a mixin object that can be merged into the bool Terraform resource block to set or update the start_replication_task field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the start_replication_task field.

fn withTableMappings

withTableMappings()

aws.string.withTableMappings constructs a mixin object that can be merged into the string Terraform resource block to set or update the table_mappings field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the table_mappings field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.

fn withTargetEndpointArn

withTargetEndpointArn()

aws.string.withTargetEndpointArn constructs a mixin object that can be merged into the string Terraform resource block to set or update the target_endpoint_arn field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the target_endpoint_arn field.