Class: AWSCDK::DMS::CfnDataProvider::MongoDBSettingsProperty

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

Overview

Provides information that defines a MongoDB endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(port:, server_name:, auth_mechanism: nil, auth_source: nil, auth_type: nil, certificate_arn: nil, database_name: nil, ssl_mode: nil) ⇒ MongoDBSettingsProperty

Returns a new instance of MongoDBSettingsProperty.

Parameters:

  • port (Numeric) —

    The port value for the MongoDB source endpoint.

  • server_name (String) —

    The name of the server on the MongoDB source endpoint.

  • auth_mechanism (String, nil) (defaults to: nil) —

    The authentication mechanism you use to access the MongoDB source endpoint.

  • auth_source (String, nil) (defaults to: nil) —

    The MongoDB database name. This setting isn't used when AuthType is set to "no" .

  • auth_type (String, nil) (defaults to: nil) —

    The authentication type you use to access the MongoDB source endpoint.

  • certificate_arn (String, nil) (defaults to: nil)
  • database_name (String, nil) (defaults to: nil) —

    The database name on the MongoDB source endpoint.

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


932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'dms/cfn_data_provider.rb', line 932

def initialize(port:, server_name:, auth_mechanism: nil, auth_source: nil, auth_type: nil, certificate_arn: nil, database_name: nil, ssl_mode: nil)
  @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")
  @auth_mechanism = auth_mechanism
  Jsii::Type.check_type(@auth_mechanism, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authMechanism") unless @auth_mechanism.nil?
  @auth_source = auth_source
  Jsii::Type.check_type(@auth_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authSource") unless @auth_source.nil?
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authType") unless @auth_type.nil?
  @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?
  @ssl_mode = ssl_mode
  Jsii::Type.check_type(@ssl_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sslMode") unless @ssl_mode.nil?
end

Instance Attribute Details

#auth_mechanism ⇒ String? (readonly)

The authentication mechanism you use to access the MongoDB source endpoint.

For the default value, in MongoDB version 2.x, "default" is "mongodb_cr" . For MongoDB version 3.x or later, "default" is "scram_sha_1" . This setting isn't used when AuthType is set to "no" .

Returns:

  • (String, nil)

See Also:



969
970
971
 
# File 'dms/cfn_data_provider.rb', line 969

def auth_mechanism
  @auth_mechanism
end

#auth_source ⇒ String? (readonly)

The MongoDB database name. This setting isn't used when AuthType is set to "no" .

The default is "admin" .

Returns:

  • (String, nil)

See Also:



976
977
978
 
# File 'dms/cfn_data_provider.rb', line 976

def auth_source
  @auth_source
end

#auth_type ⇒ String? (readonly)

The authentication type you use to access the MongoDB source endpoint.

When when set to "no" , user name and password parameters are not used and can be empty.

Returns:

  • (String, nil)

See Also:



983
984
985
 
# File 'dms/cfn_data_provider.rb', line 983

def auth_type
  @auth_type
end

#certificate_arn ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



986
987
988
 
# File 'dms/cfn_data_provider.rb', line 986

def certificate_arn
  @certificate_arn
end

#database_name ⇒ String? (readonly)

The database name on the MongoDB source endpoint.

Returns:

  • (String, nil)

See Also:



991
992
993
 
# File 'dms/cfn_data_provider.rb', line 991

def database_name
  @database_name
end

#port ⇒ Numeric (readonly)

The port value for the MongoDB source endpoint.

Returns:

  • (Numeric)

See Also:



955
956
957
 
# File 'dms/cfn_data_provider.rb', line 955

def port
  @port
end

#server_name ⇒ String (readonly)

The name of the server on the MongoDB source endpoint.

For MongoDB Atlas, provide the server name for any of the servers in the replication set.

Returns:

  • (String)

See Also:



962
963
964
 
# File 'dms/cfn_data_provider.rb', line 962

def server_name
  @server_name
end

#ssl_mode ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



994
995
996
 
# File 'dms/cfn_data_provider.rb', line 994

def ssl_mode
  @ssl_mode
end

Class Method Details

.jsii_properties ⇒ Object 



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'dms/cfn_data_provider.rb', line 996

def self.jsii_properties
  {
    :port => "port",
    :server_name => "serverName",
    :auth_mechanism => "authMechanism",
    :auth_source => "authSource",
    :auth_type => "authType",
    :certificate_arn => "certificateArn",
    :database_name => "databaseName",
    :ssl_mode => "sslMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'dms/cfn_data_provider.rb', line 1009

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