Class: AWSCDK::DMS::CfnDataProvider::PostgreSqlSettingsProperty

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

Overview

Provides information that defines a PostgreSQL endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(database_name:, port:, server_name:, ssl_mode:, certificate_arn: nil) ⇒ PostgreSqlSettingsProperty

Returns a new instance of PostgreSqlSettingsProperty.

Parameters:

  • database_name (String) —

    Database name for the endpoint.

  • port (Numeric) —

    Endpoint TCP port.

  • server_name (String) —

    The host name of the endpoint database.

  • ssl_mode (String)
  • certificate_arn (String, nil) (defaults to: nil) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'dms/cfn_data_provider.rb', line 1224

def initialize(database_name:, port:, server_name:, ssl_mode:, certificate_arn: nil)
  @database_name = database_name
  Jsii::Type.check_type(@database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName")
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port")
  @server_name = server_name
  Jsii::Type.check_type(@server_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverName")
  @ssl_mode = ssl_mode
  Jsii::Type.check_type(@ssl_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sslMode")
  @certificate_arn = certificate_arn
  Jsii::Type.check_type(@certificate_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateArn") unless @certificate_arn.nil?
end

Instance Attribute Details

#certificate_arn ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1263
1264
1265
 
# File 'dms/cfn_data_provider.rb', line 1263

def certificate_arn
  @certificate_arn
end

#database_name ⇒ String (readonly)

Database name for the endpoint.

Returns:

  • (String)

See Also:



1241
1242
1243
 
# File 'dms/cfn_data_provider.rb', line 1241

def database_name
  @database_name
end

#port ⇒ Numeric (readonly)

Endpoint TCP port.

The default is 5432.

Returns:

  • (Numeric)

See Also:



1248
1249
1250
 
# File 'dms/cfn_data_provider.rb', line 1248

def port
  @port
end

#server_name ⇒ String (readonly)

The host name of the endpoint database.

For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters , in the Endpoint field.

Returns:

  • (String)

See Also:



1257
1258
1259
 
# File 'dms/cfn_data_provider.rb', line 1257

def server_name
  @server_name
end

#ssl_mode ⇒ String (readonly)

Returns:

  • (String)

See Also:



1260
1261
1262
 
# File 'dms/cfn_data_provider.rb', line 1260

def ssl_mode
  @ssl_mode
end

Class Method Details

.jsii_properties ⇒ Object 



1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'dms/cfn_data_provider.rb', line 1265

def self.jsii_properties
  {
    :database_name => "databaseName",
    :port => "port",
    :server_name => "serverName",
    :ssl_mode => "sslMode",
    :certificate_arn => "certificateArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
 
# File 'dms/cfn_data_provider.rb', line 1275

def to_jsii
  result = {}
  result.merge!({
    "databaseName" => @database_name,
    "port" => @port,
    "serverName" => @server_name,
    "sslMode" => @ssl_mode,
    "certificateArn" => @certificate_arn,
  })
  result.compact
end