Class: AWSCDK::DMS::CfnReplicationInstance

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

Overview

The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instance.

To create a ReplicationInstance, you need permissions to create instances. You'll need similar permissions to terminate instances when you delete stacks with instances.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnReplicationInstance

Create a new AWS::DMS::ReplicationInstance.

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::CfnReplicationInstanceProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'dms/cfn_replication_instance.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DMS::CfnReplicationInstanceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG1zLkNmblJlcGxpY2F0aW9uSW5zdGFuY2VQcm9wcyJ9")), "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) 


192
193
194
 
# File 'dms/cfn_replication_instance.rb', line 192

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

.is_cfn_replication_instance(x) ⇒ Boolean

Checks whether the given object is a CfnReplicationInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
81
82
83
84
85
86
87
88
 
# File 'dms/cfn_replication_instance.rb', line 28

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 },
    :attr_replication_instance_private_ip_addresses => { kind: :property, name: "attrReplicationInstancePrivateIpAddresses", is_optional: false },
    :attr_replication_instance_public_ip_addresses => { kind: :property, name: "attrReplicationInstancePublicIpAddresses", is_optional: false },
    :replication_instance_ref => { kind: :property, name: "replicationInstanceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :replication_instance_class => { kind: :property, name: "replicationInstanceClass", is_optional: false },
    :allocated_storage => { kind: :property, name: "allocatedStorage", is_optional: true },
    :allow_major_version_upgrade => { kind: :property, name: "allowMajorVersionUpgrade", is_optional: true },
    :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :dns_name_servers => { kind: :property, name: "dnsNameServers", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :multi_az => { kind: :property, name: "multiAz", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: true },
    :replication_instance_identifier => { kind: :property, name: "replicationInstanceIdentifier", is_optional: true },
    :replication_subnet_group_identifier => { kind: :property, name: "replicationSubnetGroupIdentifier", is_optional: true },
    :resource_identifier => { kind: :property, name: "resourceIdentifier", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_security_group_ids => { kind: :property, name: "vpcSecurityGroupIds", 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.



472
473
474
475
 
# File 'dms/cfn_replication_instance.rb', line 472

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:



484
485
486
487
 
# File 'dms/cfn_replication_instance.rb', line 484

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:



494
495
496
497
 
# File 'dms/cfn_replication_instance.rb', line 494

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:



505
506
507
508
509
 
# File 'dms/cfn_replication_instance.rb', line 505

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.


562
563
564
565
566
 
# File 'dms/cfn_replication_instance.rb', line 562

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.



572
573
574
575
 
# File 'dms/cfn_replication_instance.rb', line 572

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.



584
585
586
587
588
 
# File 'dms/cfn_replication_instance.rb', line 584

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

#allocated_storage ⇒ Numeric?

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

Returns:

  • (Numeric, nil) 


244
245
246
 
# File 'dms/cfn_replication_instance.rb', line 244

def allocated_storage()
  jsii_get_property("allocatedStorage")
end

#allocated_storage=(value) ⇒ Object 



248
249
250
251
 
# File 'dms/cfn_replication_instance.rb', line 248

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

#allow_major_version_upgrade ⇒ Boolean, ...

Indicates that major version upgrades are allowed.

Returns:



256
257
258
 
# File 'dms/cfn_replication_instance.rb', line 256

def allow_major_version_upgrade()
  jsii_get_property("allowMajorVersionUpgrade")
end

#allow_major_version_upgrade=(value) ⇒ Object 



260
261
262
263
 
# File 'dms/cfn_replication_instance.rb', line 260

def allow_major_version_upgrade=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowMajorVersionUpgrade") unless value.nil?
  jsii_set_property("allowMajorVersionUpgrade", 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:



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

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:



619
620
621
622
623
624
 
# File 'dms/cfn_replication_instance.rb', line 619

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) 


197
198
199
 
# File 'dms/cfn_replication_instance.rb', line 197

def attr_id()
  jsii_get_property("attrId")
end

#attr_replication_instance_private_ip_addresses ⇒ String

One or more private IP addresses for the replication instance.

Returns:

  • (String) 


204
205
206
 
# File 'dms/cfn_replication_instance.rb', line 204

def attr_replication_instance_private_ip_addresses()
  jsii_get_property("attrReplicationInstancePrivateIpAddresses")
end

#attr_replication_instance_public_ip_addresses ⇒ String

One or more public IP addresses for the replication instance.

Returns:

  • (String) 


211
212
213
 
# File 'dms/cfn_replication_instance.rb', line 211

def attr_replication_instance_public_ip_addresses()
  jsii_get_property("attrReplicationInstancePublicIpAddresses")
end

#auto_minor_version_upgrade ⇒ Boolean, ...

A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.

Returns:



268
269
270
 
# File 'dms/cfn_replication_instance.rb', line 268

def auto_minor_version_upgrade()
  jsii_get_property("autoMinorVersionUpgrade")
end

#auto_minor_version_upgrade=(value) ⇒ Object 



272
273
274
275
 
# File 'dms/cfn_replication_instance.rb', line 272

def auto_minor_version_upgrade=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless value.nil?
  jsii_set_property("autoMinorVersionUpgrade", value)
end

#availability_zone ⇒ String?

The Availability Zone that the replication instance will be created in.

Returns:

  • (String, nil) 


280
281
282
 
# File 'dms/cfn_replication_instance.rb', line 280

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



284
285
286
287
 
# File 'dms/cfn_replication_instance.rb', line 284

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



145
146
147
 
# File 'dms/cfn_replication_instance.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'dms/cfn_replication_instance.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


628
629
630
631
 
# File 'dms/cfn_replication_instance.rb', line 628

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}) 


155
156
157
 
# File 'dms/cfn_replication_instance.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'dms/cfn_replication_instance.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'dms/cfn_replication_instance.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#dns_name_servers ⇒ String?

A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database.

Returns:

  • (String, nil) 


292
293
294
 
# File 'dms/cfn_replication_instance.rb', line 292

def dns_name_servers()
  jsii_get_property("dnsNameServers")
end

#dns_name_servers=(value) ⇒ Object 



296
297
298
299
 
# File 'dms/cfn_replication_instance.rb', line 296

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

#engine_version ⇒ String?

The engine version number of the replication instance.

Returns:

  • (String, nil) 


304
305
306
 
# File 'dms/cfn_replication_instance.rb', line 304

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



308
309
310
311
 
# File 'dms/cfn_replication_instance.rb', line 308

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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:



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

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:



652
653
654
655
 
# File 'dms/cfn_replication_instance.rb', line 652

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:



722
723
724
725
 
# File 'dms/cfn_replication_instance.rb', line 722

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

#kms_key_id ⇒ String?

An AWS key identifier that is used to encrypt the data on the replication instance.

Returns:

  • (String, nil) 


316
317
318
 
# File 'dms/cfn_replication_instance.rb', line 316

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



320
321
322
323
 
# File 'dms/cfn_replication_instance.rb', line 320

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
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) 


119
120
121
 
# File 'dms/cfn_replication_instance.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#multi_az ⇒ Boolean, ...

Specifies whether the replication instance is a Multi-AZ deployment.

Returns:



328
329
330
 
# File 'dms/cfn_replication_instance.rb', line 328

def multi_az()
  jsii_get_property("multiAz")
end

#multi_az=(value) ⇒ Object 



332
333
334
335
 
# File 'dms/cfn_replication_instance.rb', line 332

def multi_az=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiAz") unless value.nil?
  jsii_set_property("multiAz", value)
end

#network_type ⇒ String?

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing.

Returns:

  • (String, nil) 


340
341
342
 
# File 'dms/cfn_replication_instance.rb', line 340

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



344
345
346
347
 
# File 'dms/cfn_replication_instance.rb', line 344

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'dms/cfn_replication_instance.rb', line 102

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:



663
664
665
 
# File 'dms/cfn_replication_instance.rb', line 663

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:



670
671
672
 
# File 'dms/cfn_replication_instance.rb', line 670

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.



463
464
465
466
 
# File 'dms/cfn_replication_instance.rb', line 463

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

#preferred_maintenance_window ⇒ String?

The weekly time range during which system maintenance can occur, in UTC.

Returns:

  • (String, nil) 


352
353
354
 
# File 'dms/cfn_replication_instance.rb', line 352

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



356
357
358
359
 
# File 'dms/cfn_replication_instance.rb', line 356

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

#publicly_accessible ⇒ Boolean, ...

Specifies the accessibility options for the replication instance.

Returns:



364
365
366
 
# File 'dms/cfn_replication_instance.rb', line 364

def publicly_accessible()
  jsii_get_property("publiclyAccessible")
end

#publicly_accessible=(value) ⇒ Object 



368
369
370
371
 
# File 'dms/cfn_replication_instance.rb', line 368

def publicly_accessible=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless value.nil?
  jsii_set_property("publiclyAccessible", value)
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) 


138
139
140
 
# File 'dms/cfn_replication_instance.rb', line 138

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:



681
682
683
684
 
# File 'dms/cfn_replication_instance.rb', line 681

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}) 


688
689
690
691
 
# File 'dms/cfn_replication_instance.rb', line 688

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:



698
699
700
701
702
 
# File 'dms/cfn_replication_instance.rb', line 698

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_class ⇒ String

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

Returns:

  • (String) 


232
233
234
 
# File 'dms/cfn_replication_instance.rb', line 232

def replication_instance_class()
  jsii_get_property("replicationInstanceClass")
end

#replication_instance_class=(value) ⇒ Object 



236
237
238
239
 
# File 'dms/cfn_replication_instance.rb', line 236

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

#replication_instance_identifier ⇒ String?

The replication instance identifier.

This parameter is stored as a lowercase string.

Returns:

  • (String, nil) 


378
379
380
 
# File 'dms/cfn_replication_instance.rb', line 378

def replication_instance_identifier()
  jsii_get_property("replicationInstanceIdentifier")
end

#replication_instance_identifier=(value) ⇒ Object 



382
383
384
385
 
# File 'dms/cfn_replication_instance.rb', line 382

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

#replication_instance_ref ⇒ AWSCDK::Interfaces::AWSDMS::ReplicationInstanceReference

A reference to a ReplicationInstance resource.

Returns:



218
219
220
 
# File 'dms/cfn_replication_instance.rb', line 218

def replication_instance_ref()
  jsii_get_property("replicationInstanceRef")
end

#replication_subnet_group_identifier ⇒ String?

A subnet group to associate with the replication instance.

Returns:

  • (String, nil) 


390
391
392
 
# File 'dms/cfn_replication_instance.rb', line 390

def replication_subnet_group_identifier()
  jsii_get_property("replicationSubnetGroupIdentifier")
end

#replication_subnet_group_identifier=(value) ⇒ Object 



394
395
396
397
 
# File 'dms/cfn_replication_instance.rb', line 394

def replication_subnet_group_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationSubnetGroupIdentifier") unless value.nil?
  jsii_set_property("replicationSubnetGroupIdentifier", 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) 


402
403
404
 
# File 'dms/cfn_replication_instance.rb', line 402

def resource_identifier()
  jsii_get_property("resourceIdentifier")
end

#resource_identifier=(value) ⇒ Object 



406
407
408
409
 
# File 'dms/cfn_replication_instance.rb', line 406

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.



707
708
709
 
# File 'dms/cfn_replication_instance.rb', line 707

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



128
129
130
 
# File 'dms/cfn_replication_instance.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



225
226
227
 
# File 'dms/cfn_replication_instance.rb', line 225

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



414
415
416
 
# File 'dms/cfn_replication_instance.rb', line 414

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



418
419
420
421
422
 
# File 'dms/cfn_replication_instance.rb', line 418

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



439
440
441
 
# File 'dms/cfn_replication_instance.rb', line 439

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}) 


175
176
177
 
# File 'dms/cfn_replication_instance.rb', line 175

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}) 


185
186
187
 
# File 'dms/cfn_replication_instance.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


713
714
715
716
 
# File 'dms/cfn_replication_instance.rb', line 713

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

#vpc_security_group_ids ⇒ Array<String>?

Specifies the virtual private cloud (VPC) security group to be used with the replication instance.

Returns:

  • (Array<String>, nil) 


427
428
429
 
# File 'dms/cfn_replication_instance.rb', line 427

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



431
432
433
434
 
# File 'dms/cfn_replication_instance.rb', line 431

def vpc_security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroupIds") unless value.nil?
  jsii_set_property("vpcSecurityGroupIds", value)
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) 


452
453
454
455
456
457
 
# File 'dms/cfn_replication_instance.rb', line 452

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