Class: AWSCDK::DMS::CfnEndpoint

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

Overview

The AWS::DMS::Endpoint resource specifies an AWS DMS endpoint.

Currently, AWS CloudFormation supports all AWS DMS endpoint types.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEndpoint

Create a new AWS::DMS::Endpoint.

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

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpointProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG1zLkNmbkVuZHBvaW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


105
106
107
108
 
# File 'dms/cfn_endpoint.rb', line 105

def self.arn_for_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kbXMuSUVuZHBvaW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dms.CfnEndpoint", "arnForEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_endpoint_id(scope, id, endpoint_id) ⇒ AWSCDK::Interfaces::AWSDMS::IEndpointRef

Creates a new IEndpointRef from a endpointId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • endpoint_id (String)

Returns:



116
117
118
119
120
121
 
# File 'dms/cfn_endpoint.rb', line 116

def self.from_endpoint_id(scope, id, endpoint_id)
  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(endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dms.CfnEndpoint", "fromEndpointId", [scope, id, endpoint_id])
end

.is_cfn_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dms.CfnEndpoint", "isCfnEndpoint", [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
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'dms/cfn_endpoint.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_external_id => { kind: :property, name: "attrExternalId", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :endpoint_ref => { kind: :property, name: "endpointRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :endpoint_type => { kind: :property, name: "endpointType", is_optional: false },
    :engine_name => { kind: :property, name: "engineName", is_optional: false },
    :certificate_arn => { kind: :property, name: "certificateArn", is_optional: true },
    :database_name => { kind: :property, name: "databaseName", is_optional: true },
    :doc_db_settings => { kind: :property, name: "docDbSettings", is_optional: true },
    :dynamo_db_settings => { kind: :property, name: "dynamoDbSettings", is_optional: true },
    :elasticsearch_settings => { kind: :property, name: "elasticsearchSettings", is_optional: true },
    :endpoint_identifier => { kind: :property, name: "endpointIdentifier", is_optional: true },
    :extra_connection_attributes => { kind: :property, name: "extraConnectionAttributes", is_optional: true },
    :gcp_my_sql_settings => { kind: :property, name: "gcpMySqlSettings", is_optional: true },
    :ibm_db2_settings => { kind: :property, name: "ibmDb2Settings", is_optional: true },
    :kafka_settings => { kind: :property, name: "kafkaSettings", is_optional: true },
    :kinesis_settings => { kind: :property, name: "kinesisSettings", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :microsoft_sql_server_settings => { kind: :property, name: "microsoftSqlServerSettings", is_optional: true },
    :mongo_db_settings => { kind: :property, name: "mongoDbSettings", is_optional: true },
    :my_sql_settings => { kind: :property, name: "mySqlSettings", is_optional: true },
    :neptune_settings => { kind: :property, name: "neptuneSettings", is_optional: true },
    :oracle_settings => { kind: :property, name: "oracleSettings", is_optional: true },
    :password => { kind: :property, name: "password", is_optional: true },
    :port => { kind: :property, name: "port", is_optional: true },
    :postgre_sql_settings => { kind: :property, name: "postgreSqlSettings", is_optional: true },
    :redis_settings => { kind: :property, name: "redisSettings", is_optional: true },
    :redshift_settings => { kind: :property, name: "redshiftSettings", is_optional: true },
    :resource_identifier => { kind: :property, name: "resourceIdentifier", is_optional: true },
    :s3_settings => { kind: :property, name: "s3Settings", is_optional: true },
    :server_name => { kind: :property, name: "serverName", is_optional: true },
    :ssl_mode => { kind: :property, name: "sslMode", is_optional: true },
    :sybase_settings => { kind: :property, name: "sybaseSettings", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :username => { kind: :property, name: "username", 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.



683
684
685
686
 
# File 'dms/cfn_endpoint.rb', line 683

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:



695
696
697
698
 
# File 'dms/cfn_endpoint.rb', line 695

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:



705
706
707
708
 
# File 'dms/cfn_endpoint.rb', line 705

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:



716
717
718
719
720
 
# File 'dms/cfn_endpoint.rb', line 716

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.


773
774
775
776
777
 
# File 'dms/cfn_endpoint.rb', line 773

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.



783
784
785
786
 
# File 'dms/cfn_endpoint.rb', line 783

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.



795
796
797
798
799
 
# File 'dms/cfn_endpoint.rb', line 795

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:



808
809
810
811
 
# File 'dms/cfn_endpoint.rb', line 808

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:



830
831
832
833
834
835
 
# File 'dms/cfn_endpoint.rb', line 830

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

A value that can be used for cross-account validation.

Returns:

  • (String) 


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

def attr_external_id()
  jsii_get_property("attrExternalId")
end

#attr_id ⇒ String

Returns:

  • (String) 


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

def attr_id()
  jsii_get_property("attrId")
end

#certificate_arn ⇒ String?

The Amazon Resource Name (ARN) for the certificate.

Returns:

  • (String, nil) 


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

def certificate_arn()
  jsii_get_property("certificateArn")
end

#certificate_arn=(value) ⇒ Object 



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

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



178
179
180
 
# File 'dms/cfn_endpoint.rb', line 178

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'dms/cfn_endpoint.rb', line 183

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


839
840
841
842
 
# File 'dms/cfn_endpoint.rb', line 839

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


188
189
190
 
# File 'dms/cfn_endpoint.rb', line 188

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


195
196
197
 
# File 'dms/cfn_endpoint.rb', line 195

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


140
141
142
 
# File 'dms/cfn_endpoint.rb', line 140

def creation_stack()
  jsii_get_property("creationStack")
end

#database_name ⇒ String?

The name of the endpoint database.

Returns:

  • (String, nil) 


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

def database_name()
  jsii_get_property("databaseName")
end

#database_name=(value) ⇒ Object 



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

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

#doc_db_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target DocumentDB endpoint.

Returns:



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

def doc_db_settings()
  jsii_get_property("docDbSettings")
end

#doc_db_settings=(value) ⇒ Object 



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

def doc_db_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::DocDBSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuRG9jRGJTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "docDbSettings") unless value.nil?
  jsii_set_property("docDbSettings", value)
end

#dynamo_db_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the target Amazon DynamoDB endpoint.

Returns:



319
320
321
 
# File 'dms/cfn_endpoint.rb', line 319

def dynamo_db_settings()
  jsii_get_property("dynamoDbSettings")
end

#dynamo_db_settings=(value) ⇒ Object 



323
324
325
326
327
 
# File 'dms/cfn_endpoint.rb', line 323

def dynamo_db_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::DynamoDBSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuRHluYW1vRGJTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "dynamoDbSettings") unless value.nil?
  jsii_set_property("dynamoDbSettings", value)
end

#elasticsearch_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the target OpenSearch endpoint.

Returns:



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

def elasticsearch_settings()
  jsii_get_property("elasticsearchSettings")
end

#elasticsearch_settings=(value) ⇒ Object 



336
337
338
339
340
 
# File 'dms/cfn_endpoint.rb', line 336

def elasticsearch_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::ElasticsearchSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuRWxhc3RpY3NlYXJjaFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "elasticsearchSettings") unless value.nil?
  jsii_set_property("elasticsearchSettings", value)
end

#endpoint_identifier ⇒ String?

The database endpoint identifier.

Returns:

  • (String, nil) 


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

def endpoint_identifier()
  jsii_get_property("endpointIdentifier")
end

#endpoint_identifier=(value) ⇒ Object 



349
350
351
352
 
# File 'dms/cfn_endpoint.rb', line 349

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

#endpoint_ref ⇒ AWSCDK::Interfaces::AWSDMS::EndpointReference

A reference to a Endpoint resource.

Returns:



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

def endpoint_ref()
  jsii_get_property("endpointRef")
end

#endpoint_type ⇒ String

The type of endpoint.

Returns:

  • (String) 


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

def endpoint_type()
  jsii_get_property("endpointType")
end

#endpoint_type=(value) ⇒ Object 



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

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

#engine_name ⇒ String

The type of engine for the endpoint, depending on the EndpointType value.

Returns:

  • (String) 


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

def engine_name()
  jsii_get_property("engineName")
end

#engine_name=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



200
201
202
 
# File 'dms/cfn_endpoint.rb', line 200

def env()
  jsii_get_property("env")
end

#extra_connection_attributes ⇒ String?

Additional attributes associated with the connection.

Returns:

  • (String, nil) 


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

def extra_connection_attributes()
  jsii_get_property("extraConnectionAttributes")
end

#extra_connection_attributes=(value) ⇒ Object 



361
362
363
364
 
# File 'dms/cfn_endpoint.rb', line 361

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

#gcp_my_sql_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source GCP MySQL endpoint.

Returns:



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

def gcp_my_sql_settings()
  jsii_get_property("gcpMySqlSettings")
end

#gcp_my_sql_settings=(value) ⇒ Object 



373
374
375
376
377
 
# File 'dms/cfn_endpoint.rb', line 373

def gcp_my_sql_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::GcpMySQLSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuR2NwTXlTUUxTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "gcpMySqlSettings") unless value.nil?
  jsii_set_property("gcpMySqlSettings", value)
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:



852
853
854
855
856
 
# File 'dms/cfn_endpoint.rb', line 852

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:



863
864
865
866
 
# File 'dms/cfn_endpoint.rb', line 863

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

#ibm_db2_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source IBM Db2 LUW endpoint.

Returns:



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

def ibm_db2_settings()
  jsii_get_property("ibmDb2Settings")
end

#ibm_db2_settings=(value) ⇒ Object 



386
387
388
389
390
 
# File 'dms/cfn_endpoint.rb', line 386

def ibm_db2_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::IbmDB2SettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuSWJtRGIyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "ibmDb2Settings") unless value.nil?
  jsii_set_property("ibmDb2Settings", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



933
934
935
936
 
# File 'dms/cfn_endpoint.rb', line 933

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

#kafka_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the target Apache Kafka endpoint.

Returns:



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

def kafka_settings()
  jsii_get_property("kafkaSettings")
end

#kafka_settings=(value) ⇒ Object 



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

def kafka_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::KafkaSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuS2Fma2FTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "kafkaSettings") unless value.nil?
  jsii_set_property("kafkaSettings", value)
end

#kinesis_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.

Returns:



408
409
410
 
# File 'dms/cfn_endpoint.rb', line 408

def kinesis_settings()
  jsii_get_property("kinesisSettings")
end

#kinesis_settings=(value) ⇒ Object 



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

def kinesis_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::KinesisSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuS2luZXNpc1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "kinesisSettings") unless value.nil?
  jsii_set_property("kinesisSettings", value)
end

#kms_key_id ⇒ String?

An AWS key identifier that is used to encrypt the connection parameters for the endpoint.

Returns:

  • (String, nil) 


421
422
423
 
# File 'dms/cfn_endpoint.rb', line 421

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



425
426
427
428
 
# File 'dms/cfn_endpoint.rb', line 425

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) 


152
153
154
 
# File 'dms/cfn_endpoint.rb', line 152

def logical_id()
  jsii_get_property("logicalId")
end

#microsoft_sql_server_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target Microsoft SQL Server endpoint.

Returns:



433
434
435
 
# File 'dms/cfn_endpoint.rb', line 433

def microsoft_sql_server_settings()
  jsii_get_property("microsoftSqlServerSettings")
end

#microsoft_sql_server_settings=(value) ⇒ Object 



437
438
439
440
441
 
# File 'dms/cfn_endpoint.rb', line 437

def microsoft_sql_server_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::MicrosoftSqlServerSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTWljcm9zb2Z0U3FsU2VydmVyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "microsoftSqlServerSettings") unless value.nil?
  jsii_set_property("microsoftSqlServerSettings", value)
end

#mongo_db_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source MongoDB endpoint.

Returns:



446
447
448
 
# File 'dms/cfn_endpoint.rb', line 446

def mongo_db_settings()
  jsii_get_property("mongoDbSettings")
end

#mongo_db_settings=(value) ⇒ Object 



450
451
452
453
454
 
# File 'dms/cfn_endpoint.rb', line 450

def mongo_db_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::MongoDBSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTW9uZ29EYlNldHRpbmdzUHJvcGVydHkifV19fQ==")), "mongoDbSettings") unless value.nil?
  jsii_set_property("mongoDbSettings", value)
end

#my_sql_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target MySQL endpoint.

Returns:



459
460
461
 
# File 'dms/cfn_endpoint.rb', line 459

def my_sql_settings()
  jsii_get_property("mySqlSettings")
end

#my_sql_settings=(value) ⇒ Object 



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

def my_sql_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::MySqlSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTXlTcWxTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "mySqlSettings") unless value.nil?
  jsii_set_property("mySqlSettings", value)
end

#neptune_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the target Amazon Neptune endpoint.

Returns:



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

def neptune_settings()
  jsii_get_property("neptuneSettings")
end

#neptune_settings=(value) ⇒ Object 



476
477
478
479
480
 
# File 'dms/cfn_endpoint.rb', line 476

def neptune_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::NeptuneSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTmVwdHVuZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "neptuneSettings") unless value.nil?
  jsii_set_property("neptuneSettings", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


135
136
137
 
# File 'dms/cfn_endpoint.rb', line 135

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:



874
875
876
 
# File 'dms/cfn_endpoint.rb', line 874

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:



881
882
883
 
# File 'dms/cfn_endpoint.rb', line 881

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

#oracle_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target Oracle endpoint.

Returns:



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

def oracle_settings()
  jsii_get_property("oracleSettings")
end

#oracle_settings=(value) ⇒ Object 



489
490
491
492
493
 
# File 'dms/cfn_endpoint.rb', line 489

def oracle_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::OracleSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuT3JhY2xlU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "oracleSettings") unless value.nil?
  jsii_set_property("oracleSettings", value)
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.



674
675
676
677
 
# File 'dms/cfn_endpoint.rb', line 674

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

#password ⇒ String?

The password to be used to log in to the endpoint database.

Returns:

  • (String, nil) 


498
499
500
 
# File 'dms/cfn_endpoint.rb', line 498

def password()
  jsii_get_property("password")
end

#password=(value) ⇒ Object 



502
503
504
505
 
# File 'dms/cfn_endpoint.rb', line 502

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

#port ⇒ Numeric?

The port used by the endpoint database.

Returns:

  • (Numeric, nil) 


510
511
512
 
# File 'dms/cfn_endpoint.rb', line 510

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object 



514
515
516
517
 
# File 'dms/cfn_endpoint.rb', line 514

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

#postgre_sql_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target PostgreSQL endpoint.

Returns:



522
523
524
 
# File 'dms/cfn_endpoint.rb', line 522

def postgre_sql_settings()
  jsii_get_property("postgreSqlSettings")
end

#postgre_sql_settings=(value) ⇒ Object 



526
527
528
529
530
 
# File 'dms/cfn_endpoint.rb', line 526

def postgre_sql_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::PostgreSqlSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUG9zdGdyZVNxbFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "postgreSqlSettings") unless value.nil?
  jsii_set_property("postgreSqlSettings", value)
end

#redis_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the target Redis endpoint.

Returns:



535
536
537
 
# File 'dms/cfn_endpoint.rb', line 535

def redis_settings()
  jsii_get_property("redisSettings")
end

#redis_settings=(value) ⇒ Object 



539
540
541
542
543
 
# File 'dms/cfn_endpoint.rb', line 539

def redis_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::RedisSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUmVkaXNTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "redisSettings") unless value.nil?
  jsii_set_property("redisSettings", value)
end

#redshift_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the Amazon Redshift endpoint.

Returns:



548
549
550
 
# File 'dms/cfn_endpoint.rb', line 548

def redshift_settings()
  jsii_get_property("redshiftSettings")
end

#redshift_settings=(value) ⇒ Object 



552
553
554
555
556
 
# File 'dms/cfn_endpoint.rb', line 552

def redshift_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::RedshiftSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUmVkc2hpZnRTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "redshiftSettings") unless value.nil?
  jsii_set_property("redshiftSettings", 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) 


171
172
173
 
# File 'dms/cfn_endpoint.rb', line 171

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:



892
893
894
895
 
# File 'dms/cfn_endpoint.rb', line 892

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


899
900
901
902
 
# File 'dms/cfn_endpoint.rb', line 899

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:



909
910
911
912
913
 
# File 'dms/cfn_endpoint.rb', line 909

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

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


561
562
563
 
# File 'dms/cfn_endpoint.rb', line 561

def resource_identifier()
  jsii_get_property("resourceIdentifier")
end

#resource_identifier=(value) ⇒ Object 



565
566
567
568
 
# File 'dms/cfn_endpoint.rb', line 565

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

#s3_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target Amazon S3 endpoint.

Returns:



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

def s3_settings()
  jsii_get_property("s3Settings")
end

#s3_settings=(value) ⇒ Object 



577
578
579
580
581
 
# File 'dms/cfn_endpoint.rb', line 577

def s3_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::S3SettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUzNTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "s3Settings") unless value.nil?
  jsii_set_property("s3Settings", value)
end

#server_name ⇒ String?

The name of the server where the endpoint database resides.

Returns:

  • (String, nil) 


586
587
588
 
# File 'dms/cfn_endpoint.rb', line 586

def server_name()
  jsii_get_property("serverName")
end

#server_name=(value) ⇒ Object 



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

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



918
919
920
 
# File 'dms/cfn_endpoint.rb', line 918

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

#ssl_mode ⇒ String?

The Secure Sockets Layer (SSL) mode to use for the SSL connection.

The default is none .

Returns:

  • (String, nil) 


600
601
602
 
# File 'dms/cfn_endpoint.rb', line 600

def ssl_mode()
  jsii_get_property("sslMode")
end

#ssl_mode=(value) ⇒ Object 



604
605
606
607
 
# File 'dms/cfn_endpoint.rb', line 604

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



161
162
163
 
# File 'dms/cfn_endpoint.rb', line 161

def stack()
  jsii_get_property("stack")
end

#sybase_settings ⇒ AWSCDK::IResolvable, ...

Settings in JSON format for the source and target SAP ASE endpoint.

Returns:



612
613
614
 
# File 'dms/cfn_endpoint.rb', line 612

def sybase_settings()
  jsii_get_property("sybaseSettings")
end

#sybase_settings=(value) ⇒ Object 



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

def sybase_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::SybaseSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuU3liYXNlU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "sybaseSettings") unless value.nil?
  jsii_set_property("sybaseSettings", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

One or more tags to be assigned to the endpoint.

Returns:



625
626
627
 
# File 'dms/cfn_endpoint.rb', line 625

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



629
630
631
632
633
 
# File 'dms/cfn_endpoint.rb', line 629

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



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

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


208
209
210
 
# File 'dms/cfn_endpoint.rb', line 208

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#username ⇒ String?

The user name to be used to log in to the endpoint database.

Returns:

  • (String, nil) 


638
639
640
 
# File 'dms/cfn_endpoint.rb', line 638

def username()
  jsii_get_property("username")
end

#username=(value) ⇒ Object 



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

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


924
925
926
927
 
# File 'dms/cfn_endpoint.rb', line 924

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) 


663
664
665
666
667
668
 
# File 'dms/cfn_endpoint.rb', line 663

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