Class: AWSCDK::DMS::CfnEndpointProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_endpoint_props.rb

Overview

Properties for defining a CfnEndpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_type:, engine_name:, certificate_arn: nil, database_name: nil, doc_db_settings: nil, dynamo_db_settings: nil, elasticsearch_settings: nil, endpoint_identifier: nil, extra_connection_attributes: nil, gcp_my_sql_settings: nil, ibm_db2_settings: nil, kafka_settings: nil, kinesis_settings: nil, kms_key_id: nil, microsoft_sql_server_settings: nil, mongo_db_settings: nil, my_sql_settings: nil, neptune_settings: nil, oracle_settings: nil, password: nil, port: nil, postgre_sql_settings: nil, redis_settings: nil, redshift_settings: nil, resource_identifier: nil, s3_settings: nil, server_name: nil, ssl_mode: nil, sybase_settings: nil, tags: nil, username: nil) ⇒ CfnEndpointProps

Returns a new instance of CfnEndpointProps.

Parameters:



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
102
103
 
# File 'dms/cfn_endpoint_props.rb', line 40

def initialize(endpoint_type:, engine_name:, certificate_arn: nil, database_name: nil, doc_db_settings: nil, dynamo_db_settings: nil, elasticsearch_settings: nil, endpoint_identifier: nil, extra_connection_attributes: nil, gcp_my_sql_settings: nil, ibm_db2_settings: nil, kafka_settings: nil, kinesis_settings: nil, kms_key_id: nil, microsoft_sql_server_settings: nil, mongo_db_settings: nil, my_sql_settings: nil, neptune_settings: nil, oracle_settings: nil, password: nil, port: nil, postgre_sql_settings: nil, redis_settings: nil, redshift_settings: nil, resource_identifier: nil, s3_settings: nil, server_name: nil, ssl_mode: nil, sybase_settings: nil, tags: nil, username: nil)
  @endpoint_type = endpoint_type
  Jsii::Type.check_type(@endpoint_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointType")
  @engine_name = engine_name
  Jsii::Type.check_type(@engine_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineName")
  @certificate_arn = certificate_arn
  Jsii::Type.check_type(@certificate_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateArn") unless @certificate_arn.nil?
  @database_name = database_name
  Jsii::Type.check_type(@database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName") unless @database_name.nil?
  @doc_db_settings = doc_db_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::DocDBSettingsProperty.new(**doc_db_settings.transform_keys(&:to_sym)) : doc_db_settings
  Jsii::Type.check_type(@doc_db_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuRG9jRGJTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "docDbSettings") unless @doc_db_settings.nil?
  @dynamo_db_settings = dynamo_db_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::DynamoDBSettingsProperty.new(**dynamo_db_settings.transform_keys(&:to_sym)) : dynamo_db_settings
  Jsii::Type.check_type(@dynamo_db_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuRHluYW1vRGJTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "dynamoDbSettings") unless @dynamo_db_settings.nil?
  @elasticsearch_settings = elasticsearch_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::ElasticsearchSettingsProperty.new(**elasticsearch_settings.transform_keys(&:to_sym)) : elasticsearch_settings
  Jsii::Type.check_type(@elasticsearch_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuRWxhc3RpY3NlYXJjaFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "elasticsearchSettings") unless @elasticsearch_settings.nil?
  @endpoint_identifier = endpoint_identifier
  Jsii::Type.check_type(@endpoint_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointIdentifier") unless @endpoint_identifier.nil?
  @extra_connection_attributes = extra_connection_attributes
  Jsii::Type.check_type(@extra_connection_attributes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "extraConnectionAttributes") unless @extra_connection_attributes.nil?
  @gcp_my_sql_settings = gcp_my_sql_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::GcpMySQLSettingsProperty.new(**gcp_my_sql_settings.transform_keys(&:to_sym)) : gcp_my_sql_settings
  Jsii::Type.check_type(@gcp_my_sql_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuR2NwTXlTUUxTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "gcpMySqlSettings") unless @gcp_my_sql_settings.nil?
  @ibm_db2_settings = ibm_db2_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::IbmDB2SettingsProperty.new(**ibm_db2_settings.transform_keys(&:to_sym)) : ibm_db2_settings
  Jsii::Type.check_type(@ibm_db2_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuSWJtRGIyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "ibmDb2Settings") unless @ibm_db2_settings.nil?
  @kafka_settings = kafka_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::KafkaSettingsProperty.new(**kafka_settings.transform_keys(&:to_sym)) : kafka_settings
  Jsii::Type.check_type(@kafka_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuS2Fma2FTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "kafkaSettings") unless @kafka_settings.nil?
  @kinesis_settings = kinesis_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::KinesisSettingsProperty.new(**kinesis_settings.transform_keys(&:to_sym)) : kinesis_settings
  Jsii::Type.check_type(@kinesis_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuS2luZXNpc1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "kinesisSettings") unless @kinesis_settings.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @microsoft_sql_server_settings = microsoft_sql_server_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::MicrosoftSqlServerSettingsProperty.new(**microsoft_sql_server_settings.transform_keys(&:to_sym)) : microsoft_sql_server_settings
  Jsii::Type.check_type(@microsoft_sql_server_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTWljcm9zb2Z0U3FsU2VydmVyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "microsoftSqlServerSettings") unless @microsoft_sql_server_settings.nil?
  @mongo_db_settings = mongo_db_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::MongoDBSettingsProperty.new(**mongo_db_settings.transform_keys(&:to_sym)) : mongo_db_settings
  Jsii::Type.check_type(@mongo_db_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTW9uZ29EYlNldHRpbmdzUHJvcGVydHkifV19fQ==")), "mongoDbSettings") unless @mongo_db_settings.nil?
  @my_sql_settings = my_sql_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::MySqlSettingsProperty.new(**my_sql_settings.transform_keys(&:to_sym)) : my_sql_settings
  Jsii::Type.check_type(@my_sql_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTXlTcWxTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "mySqlSettings") unless @my_sql_settings.nil?
  @neptune_settings = neptune_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::NeptuneSettingsProperty.new(**neptune_settings.transform_keys(&:to_sym)) : neptune_settings
  Jsii::Type.check_type(@neptune_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuTmVwdHVuZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "neptuneSettings") unless @neptune_settings.nil?
  @oracle_settings = oracle_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::OracleSettingsProperty.new(**oracle_settings.transform_keys(&:to_sym)) : oracle_settings
  Jsii::Type.check_type(@oracle_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuT3JhY2xlU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "oracleSettings") unless @oracle_settings.nil?
  @password = password
  Jsii::Type.check_type(@password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless @password.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @postgre_sql_settings = postgre_sql_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::PostgreSqlSettingsProperty.new(**postgre_sql_settings.transform_keys(&:to_sym)) : postgre_sql_settings
  Jsii::Type.check_type(@postgre_sql_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUG9zdGdyZVNxbFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "postgreSqlSettings") unless @postgre_sql_settings.nil?
  @redis_settings = redis_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::RedisSettingsProperty.new(**redis_settings.transform_keys(&:to_sym)) : redis_settings
  Jsii::Type.check_type(@redis_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUmVkaXNTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "redisSettings") unless @redis_settings.nil?
  @redshift_settings = redshift_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::RedshiftSettingsProperty.new(**redshift_settings.transform_keys(&:to_sym)) : redshift_settings
  Jsii::Type.check_type(@redshift_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUmVkc2hpZnRTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "redshiftSettings") unless @redshift_settings.nil?
  @resource_identifier = resource_identifier
  Jsii::Type.check_type(@resource_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceIdentifier") unless @resource_identifier.nil?
  @s3_settings = s3_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::S3SettingsProperty.new(**s3_settings.transform_keys(&:to_sym)) : s3_settings
  Jsii::Type.check_type(@s3_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuUzNTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "s3Settings") unless @s3_settings.nil?
  @server_name = server_name
  Jsii::Type.check_type(@server_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverName") unless @server_name.nil?
  @ssl_mode = ssl_mode
  Jsii::Type.check_type(@ssl_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sslMode") unless @ssl_mode.nil?
  @sybase_settings = sybase_settings.is_a?(Hash) ? ::AWSCDK::DMS::CfnEndpoint::SybaseSettingsProperty.new(**sybase_settings.transform_keys(&:to_sym)) : sybase_settings
  Jsii::Type.check_type(@sybase_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuRW5kcG9pbnQuU3liYXNlU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "sybaseSettings") unless @sybase_settings.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @username = username
  Jsii::Type.check_type(@username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username") unless @username.nil?
end

Instance Attribute Details

#certificate_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) for the certificate.

Returns:

  • (String, nil)

See Also:



123
124
125
 
# File 'dms/cfn_endpoint_props.rb', line 123

def certificate_arn
  @certificate_arn
end

#database_name ⇒ String? (readonly)

The name of the endpoint database.

For a MySQL source or target endpoint, don't specify DatabaseName . To migrate to a specific database, use this setting and target_db_type .

Returns:

  • (String, nil)

See Also:



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

def database_name
  @database_name
end

#doc_db_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Returns:

See Also:



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

def doc_db_settings
  @doc_db_settings
end

#dynamo_db_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the target Amazon DynamoDB endpoint.

For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .

Returns:

See Also:



144
145
146
 
# File 'dms/cfn_endpoint_props.rb', line 144

def dynamo_db_settings
  @dynamo_db_settings
end

#elasticsearch_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the target OpenSearch endpoint.

For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



151
152
153
 
# File 'dms/cfn_endpoint_props.rb', line 151

def elasticsearch_settings
  @elasticsearch_settings
end

#endpoint_identifier ⇒ String? (readonly)

The database endpoint identifier.

Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

Returns:

  • (String, nil)

See Also:



158
159
160
 
# File 'dms/cfn_endpoint_props.rb', line 158

def endpoint_identifier
  @endpoint_identifier
end

#endpoint_type ⇒ String (readonly)

The type of endpoint.

Valid values are source and target .

Returns:

  • (String)

See Also:



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

def endpoint_type
  @endpoint_type
end

#engine_name ⇒ String (readonly)

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

Valid values : mysql | oracle | postgres | mariadb | aurora | aurora-postgresql | opensearch | redshift | redshift-serverless | s3 | db2 | azuredb | sybase | dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptune

Returns:

  • (String)

See Also:



118
119
120
 
# File 'dms/cfn_endpoint_props.rb', line 118

def engine_name
  @engine_name
end

#extra_connection_attributes ⇒ String? (readonly)

Additional attributes associated with the connection.

Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



165
166
167
 
# File 'dms/cfn_endpoint_props.rb', line 165

def extra_connection_attributes
  @extra_connection_attributes
end

#gcp_my_sql_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the source GCP MySQL endpoint.

These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



172
173
174
 
# File 'dms/cfn_endpoint_props.rb', line 172

def gcp_my_sql_settings
  @gcp_my_sql_settings
end

#ibm_db2_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



179
180
181
 
# File 'dms/cfn_endpoint_props.rb', line 179

def ibm_db2_settings
  @ibm_db2_settings
end

#kafka_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the target Apache Kafka endpoint.

For more information about other available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide .

Returns:

See Also:



186
187
188
 
# File 'dms/cfn_endpoint_props.rb', line 186

def kafka_settings
  @kafka_settings
end

#kinesis_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide .

Returns:

See Also:



193
194
195
 
# File 'dms/cfn_endpoint_props.rb', line 193

def kinesis_settings
  @kinesis_settings
end

#kms_key_id ⇒ String? (readonly)

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

If you don't specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.

AWS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .

Returns:

  • (String, nil)

See Also:



202
203
204
 
# File 'dms/cfn_endpoint_props.rb', line 202

def kms_key_id
  @kms_key_id
end

#microsoft_sql_server_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



209
210
211
 
# File 'dms/cfn_endpoint_props.rb', line 209

def microsoft_sql_server_settings
  @microsoft_sql_server_settings
end

#mongo_db_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the source MongoDB endpoint.

For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Returns:

See Also:



216
217
218
 
# File 'dms/cfn_endpoint_props.rb', line 216

def mongo_db_settings
  @mongo_db_settings
end

#my_sql_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



223
224
225
 
# File 'dms/cfn_endpoint_props.rb', line 223

def my_sql_settings
  @my_sql_settings
end

#neptune_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the target Amazon Neptune endpoint.

For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .

Returns:

See Also:



230
231
232
 
# File 'dms/cfn_endpoint_props.rb', line 230

def neptune_settings
  @neptune_settings
end

#oracle_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



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

def oracle_settings
  @oracle_settings
end

#password ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



242
243
244
 
# File 'dms/cfn_endpoint_props.rb', line 242

def password
  @password
end

#port ⇒ Numeric? (readonly)

The port used by the endpoint database.

Returns:

  • (Numeric, nil)

See Also:



247
248
249
 
# File 'dms/cfn_endpoint_props.rb', line 247

def port
  @port
end

#postgre_sql_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



254
255
256
 
# File 'dms/cfn_endpoint_props.rb', line 254

def postgre_sql_settings
  @postgre_sql_settings
end

#redis_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the target Redis endpoint.

For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .

Returns:

See Also:



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

def redis_settings
  @redis_settings
end

#redshift_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings in JSON format for the Amazon Redshift endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



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

def redshift_settings
  @redshift_settings
end

#resource_identifier ⇒ String? (readonly)

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

The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 .

For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .

Returns:

  • (String, nil)

See Also:



277
278
279
 
# File 'dms/cfn_endpoint_props.rb', line 277

def resource_identifier
  @resource_identifier
end

#s3_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



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

def s3_settings
  @s3_settings
end

#server_name ⇒ String? (readonly)

The name of the server where the endpoint database resides.

Returns:

  • (String, nil)

See Also:



289
290
291
 
# File 'dms/cfn_endpoint_props.rb', line 289

def server_name
  @server_name
end

#ssl_mode ⇒ String? (readonly)

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

When engine_name is set to S3, the only allowed value is none .

Returns:

  • (String, nil)

See Also:



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

def ssl_mode
  @ssl_mode
end

#sybase_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

See Also:



303
304
305
 
# File 'dms/cfn_endpoint_props.rb', line 303

def sybase_settings
  @sybase_settings
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

One or more tags to be assigned to the endpoint.

Returns:

See Also:



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

def tags
  @tags
end

#username ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



313
314
315
 
# File 'dms/cfn_endpoint_props.rb', line 313

def username
  @username
end

Class Method Details

.jsii_properties ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'dms/cfn_endpoint_props.rb', line 315

def self.jsii_properties
  {
    :endpoint_type => "endpointType",
    :engine_name => "engineName",
    :certificate_arn => "certificateArn",
    :database_name => "databaseName",
    :doc_db_settings => "docDbSettings",
    :dynamo_db_settings => "dynamoDbSettings",
    :elasticsearch_settings => "elasticsearchSettings",
    :endpoint_identifier => "endpointIdentifier",
    :extra_connection_attributes => "extraConnectionAttributes",
    :gcp_my_sql_settings => "gcpMySqlSettings",
    :ibm_db2_settings => "ibmDb2Settings",
    :kafka_settings => "kafkaSettings",
    :kinesis_settings => "kinesisSettings",
    :kms_key_id => "kmsKeyId",
    :microsoft_sql_server_settings => "microsoftSqlServerSettings",
    :mongo_db_settings => "mongoDbSettings",
    :my_sql_settings => "mySqlSettings",
    :neptune_settings => "neptuneSettings",
    :oracle_settings => "oracleSettings",
    :password => "password",
    :port => "port",
    :postgre_sql_settings => "postgreSqlSettings",
    :redis_settings => "redisSettings",
    :redshift_settings => "redshiftSettings",
    :resource_identifier => "resourceIdentifier",
    :s3_settings => "s3Settings",
    :server_name => "serverName",
    :ssl_mode => "sslMode",
    :sybase_settings => "sybaseSettings",
    :tags => "tags",
    :username => "username",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'dms/cfn_endpoint_props.rb', line 351

def to_jsii
  result = {}
  result.merge!({
    "endpointType" => @endpoint_type,
    "engineName" => @engine_name,
    "certificateArn" => @certificate_arn,
    "databaseName" => @database_name,
    "docDbSettings" => @doc_db_settings,
    "dynamoDbSettings" => @dynamo_db_settings,
    "elasticsearchSettings" => @elasticsearch_settings,
    "endpointIdentifier" => @endpoint_identifier,
    "extraConnectionAttributes" => @extra_connection_attributes,
    "gcpMySqlSettings" => @gcp_my_sql_settings,
    "ibmDb2Settings" => @ibm_db2_settings,
    "kafkaSettings" => @kafka_settings,
    "kinesisSettings" => @kinesis_settings,
    "kmsKeyId" => @kms_key_id,
    "microsoftSqlServerSettings" => @microsoft_sql_server_settings,
    "mongoDbSettings" => @mongo_db_settings,
    "mySqlSettings" => @my_sql_settings,
    "neptuneSettings" => @neptune_settings,
    "oracleSettings" => @oracle_settings,
    "password" => @password,
    "port" => @port,
    "postgreSqlSettings" => @postgre_sql_settings,
    "redisSettings" => @redis_settings,
    "redshiftSettings" => @redshift_settings,
    "resourceIdentifier" => @resource_identifier,
    "s3Settings" => @s3_settings,
    "serverName" => @server_name,
    "sslMode" => @ssl_mode,
    "sybaseSettings" => @sybase_settings,
    "tags" => @tags,
    "username" => @username,
  })
  result.compact
end