Class: AWSCDK::DMS::CfnReplicationTask

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDMS::IReplicationTaskRef
Defined in:
dms/cfn_replication_task.rb

Overview

The AWS::DMS::ReplicationTask resource creates an AWS DMS replication task.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnReplicationTask

Create a new AWS::DMS::ReplicationTask.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::DMS::CfnReplicationTaskProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'dms/cfn_replication_task.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DMS::CfnReplicationTaskProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG1zLkNmblJlcGxpY2F0aW9uVGFza1Byb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


184
185
186
 
# File 'dms/cfn_replication_task.rb', line 184

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_dms.CfnReplicationTask", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_replication_task(x) ⇒ Boolean

Checks whether the given object is a CfnReplicationTask.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'dms/cfn_replication_task.rb', line 86

def self.is_cfn_replication_task(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dms.CfnReplicationTask", "isCfnReplicationTask", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'dms/cfn_replication_task.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :replication_task_ref => { kind: :property, name: "replicationTaskRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :migration_type => { kind: :property, name: "migrationType", is_optional: false },
    :replication_instance_arn => { kind: :property, name: "replicationInstanceArn", is_optional: false },
    :source_endpoint_arn => { kind: :property, name: "sourceEndpointArn", is_optional: false },
    :table_mappings => { kind: :property, name: "tableMappings", is_optional: false },
    :target_endpoint_arn => { kind: :property, name: "targetEndpointArn", is_optional: false },
    :cdc_start_position => { kind: :property, name: "cdcStartPosition", is_optional: true },
    :cdc_start_time => { kind: :property, name: "cdcStartTime", is_optional: true },
    :cdc_stop_position => { kind: :property, name: "cdcStopPosition", is_optional: true },
    :replication_task_identifier => { kind: :property, name: "replicationTaskIdentifier", is_optional: true },
    :replication_task_settings => { kind: :property, name: "replicationTaskSettings", is_optional: true },
    :resource_identifier => { kind: :property, name: "resourceIdentifier", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :task_data => { kind: :property, name: "taskData", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



400
401
402
403
 
# File 'dms/cfn_replication_task.rb', line 400

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



412
413
414
415
 
# File 'dms/cfn_replication_task.rb', line 412

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



422
423
424
425
 
# File 'dms/cfn_replication_task.rb', line 422

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



433
434
435
436
437
 
# File 'dms/cfn_replication_task.rb', line 433

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


490
491
492
493
494
 
# File 'dms/cfn_replication_task.rb', line 490

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



500
501
502
503
 
# File 'dms/cfn_replication_task.rb', line 500

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



512
513
514
515
516
 
# File 'dms/cfn_replication_task.rb', line 512

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



525
526
527
528
 
# File 'dms/cfn_replication_task.rb', line 525

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



547
548
549
550
551
552
 
# File 'dms/cfn_replication_task.rb', line 547

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

Returns:

  • (String) 


189
190
191
 
# File 'dms/cfn_replication_task.rb', line 189

def attr_id()
  jsii_get_property("attrId")
end

#cdc_start_position ⇒ String?

Indicates when you want a change data capture (CDC) operation to start.

Returns:

  • (String, nil) 


270
271
272
 
# File 'dms/cfn_replication_task.rb', line 270

def cdc_start_position()
  jsii_get_property("cdcStartPosition")
end

#cdc_start_position=(value) ⇒ Object 



274
275
276
277
 
# File 'dms/cfn_replication_task.rb', line 274

def cdc_start_position=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdcStartPosition") unless value.nil?
  jsii_set_property("cdcStartPosition", value)
end

#cdc_start_time ⇒ Numeric?

Indicates the start time for a change data capture (CDC) operation.

Returns:

  • (Numeric, nil) 


282
283
284
 
# File 'dms/cfn_replication_task.rb', line 282

def cdc_start_time()
  jsii_get_property("cdcStartTime")
end

#cdc_start_time=(value) ⇒ Object 



286
287
288
289
 
# File 'dms/cfn_replication_task.rb', line 286

def cdc_start_time=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cdcStartTime") unless value.nil?
  jsii_set_property("cdcStartTime", value)
end

#cdc_stop_position ⇒ String?

Indicates when you want a change data capture (CDC) operation to stop.

Returns:

  • (String, nil) 


294
295
296
 
# File 'dms/cfn_replication_task.rb', line 294

def cdc_stop_position()
  jsii_get_property("cdcStopPosition")
end

#cdc_stop_position=(value) ⇒ Object 



298
299
300
301
 
# File 'dms/cfn_replication_task.rb', line 298

def cdc_stop_position=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdcStopPosition") unless value.nil?
  jsii_set_property("cdcStopPosition", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



137
138
139
 
# File 'dms/cfn_replication_task.rb', line 137

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


142
143
144
 
# File 'dms/cfn_replication_task.rb', line 142

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


556
557
558
559
 
# File 'dms/cfn_replication_task.rb', line 556

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


147
148
149
 
# File 'dms/cfn_replication_task.rb', line 147

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


154
155
156
 
# File 'dms/cfn_replication_task.rb', line 154

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


99
100
101
 
# File 'dms/cfn_replication_task.rb', line 99

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



159
160
161
 
# File 'dms/cfn_replication_task.rb', line 159

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



569
570
571
572
573
 
# File 'dms/cfn_replication_task.rb', line 569

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



580
581
582
583
 
# File 'dms/cfn_replication_task.rb', line 580

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



650
651
652
653
 
# File 'dms/cfn_replication_task.rb', line 650

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


111
112
113
 
# File 'dms/cfn_replication_task.rb', line 111

def logical_id()
  jsii_get_property("logicalId")
end

#migration_type ⇒ String

The migration type.

Returns:

  • (String) 


210
211
212
 
# File 'dms/cfn_replication_task.rb', line 210

def migration_type()
  jsii_get_property("migrationType")
end

#migration_type=(value) ⇒ Object 



214
215
216
217
 
# File 'dms/cfn_replication_task.rb', line 214

def migration_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "migrationType")
  jsii_set_property("migrationType", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'dms/cfn_replication_task.rb', line 94

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



591
592
593
 
# File 'dms/cfn_replication_task.rb', line 591

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



598
599
600
 
# File 'dms/cfn_replication_task.rb', line 598

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



391
392
393
394
 
# File 'dms/cfn_replication_task.rb', line 391

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


130
131
132
 
# File 'dms/cfn_replication_task.rb', line 130

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



609
610
611
612
 
# File 'dms/cfn_replication_task.rb', line 609

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


616
617
618
619
 
# File 'dms/cfn_replication_task.rb', line 616

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



626
627
628
629
630
 
# File 'dms/cfn_replication_task.rb', line 626

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#replication_instance_arn ⇒ String

The Amazon Resource Name (ARN) of a replication instance.

Returns:

  • (String) 


222
223
224
 
# File 'dms/cfn_replication_task.rb', line 222

def replication_instance_arn()
  jsii_get_property("replicationInstanceArn")
end

#replication_instance_arn=(value) ⇒ Object 



226
227
228
229
 
# File 'dms/cfn_replication_task.rb', line 226

def replication_instance_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationInstanceArn")
  jsii_set_property("replicationInstanceArn", value)
end

#replication_task_identifier ⇒ String?

An identifier for the replication task.

Returns:

  • (String, nil) 


306
307
308
 
# File 'dms/cfn_replication_task.rb', line 306

def replication_task_identifier()
  jsii_get_property("replicationTaskIdentifier")
end

#replication_task_identifier=(value) ⇒ Object 



310
311
312
313
 
# File 'dms/cfn_replication_task.rb', line 310

def replication_task_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationTaskIdentifier") unless value.nil?
  jsii_set_property("replicationTaskIdentifier", value)
end

#replication_task_ref ⇒ AWSCDK::Interfaces::AWSDMS::ReplicationTaskReference

A reference to a ReplicationTask resource.

Returns:



196
197
198
 
# File 'dms/cfn_replication_task.rb', line 196

def replication_task_ref()
  jsii_get_property("replicationTaskRef")
end

#replication_task_settings ⇒ String?

Overall settings for the task, in JSON format.

Returns:

  • (String, nil) 


318
319
320
 
# File 'dms/cfn_replication_task.rb', line 318

def replication_task_settings()
  jsii_get_property("replicationTaskSettings")
end

#replication_task_settings=(value) ⇒ Object 



322
323
324
325
 
# File 'dms/cfn_replication_task.rb', line 322

def replication_task_settings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationTaskSettings") unless value.nil?
  jsii_set_property("replicationTaskSettings", value)
end

#resource_identifier ⇒ String?

A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

Returns:

  • (String, nil) 


330
331
332
 
# File 'dms/cfn_replication_task.rb', line 330

def resource_identifier()
  jsii_get_property("resourceIdentifier")
end

#resource_identifier=(value) ⇒ Object 



334
335
336
337
 
# File 'dms/cfn_replication_task.rb', line 334

def resource_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceIdentifier") unless value.nil?
  jsii_set_property("resourceIdentifier", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



635
636
637
 
# File 'dms/cfn_replication_task.rb', line 635

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_endpoint_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

Returns:

  • (String) 


234
235
236
 
# File 'dms/cfn_replication_task.rb', line 234

def source_endpoint_arn()
  jsii_get_property("sourceEndpointArn")
end

#source_endpoint_arn=(value) ⇒ Object 



238
239
240
241
 
# File 'dms/cfn_replication_task.rb', line 238

def source_endpoint_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceEndpointArn")
  jsii_set_property("sourceEndpointArn", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



120
121
122
 
# File 'dms/cfn_replication_task.rb', line 120

def stack()
  jsii_get_property("stack")
end

#table_mappings ⇒ String

The table mappings for the task, in JSON format.

Returns:

  • (String) 


246
247
248
 
# File 'dms/cfn_replication_task.rb', line 246

def table_mappings()
  jsii_get_property("tableMappings")
end

#table_mappings=(value) ⇒ Object 



250
251
252
253
 
# File 'dms/cfn_replication_task.rb', line 250

def table_mappings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tableMappings")
  jsii_set_property("tableMappings", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



203
204
205
 
# File 'dms/cfn_replication_task.rb', line 203

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

One or more tags to be assigned to the replication task.

Returns:



342
343
344
 
# File 'dms/cfn_replication_task.rb', line 342

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



346
347
348
349
350
 
# File 'dms/cfn_replication_task.rb', line 346

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#target_endpoint_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

Returns:

  • (String) 


258
259
260
 
# File 'dms/cfn_replication_task.rb', line 258

def target_endpoint_arn()
  jsii_get_property("targetEndpointArn")
end

#target_endpoint_arn=(value) ⇒ Object 



262
263
264
265
 
# File 'dms/cfn_replication_task.rb', line 262

def target_endpoint_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetEndpointArn")
  jsii_set_property("targetEndpointArn", value)
end

#task_data ⇒ String?

Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Returns:

  • (String, nil) 


355
356
357
 
# File 'dms/cfn_replication_task.rb', line 355

def task_data()
  jsii_get_property("taskData")
end

#task_data=(value) ⇒ Object 



359
360
361
362
 
# File 'dms/cfn_replication_task.rb', line 359

def task_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "taskData") unless value.nil?
  jsii_set_property("taskData", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



367
368
369
 
# File 'dms/cfn_replication_task.rb', line 367

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


167
168
169
 
# File 'dms/cfn_replication_task.rb', line 167

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'dms/cfn_replication_task.rb', line 177

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


641
642
643
644
 
# File 'dms/cfn_replication_task.rb', line 641

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


380
381
382
383
384
385
 
# File 'dms/cfn_replication_task.rb', line 380

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end