Class: AWSCDK::DMS::CfnDataProvider::OracleSettingsProperty

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

Overview

Provides information that defines an Oracle 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:, asm_server: nil, certificate_arn: nil, secrets_manager_oracle_asm_access_role_arn: nil, secrets_manager_oracle_asm_secret_id: nil, secrets_manager_security_db_encryption_access_role_arn: nil, secrets_manager_security_db_encryption_secret_id: nil) ⇒ OracleSettingsProperty

Returns a new instance of OracleSettingsProperty.

Parameters:

  • database_name (String) —

    Database name for the endpoint.

  • port (Numeric) —

    Endpoint TCP port.

  • server_name (String) —

    Fully qualified domain name of the endpoint.

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

    For an Oracle source endpoint, your ASM server address.

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

    Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

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

    Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

  • secrets_manager_security_db_encryption_access_role_arn (String, nil) (defaults to: nil)
  • secrets_manager_security_db_encryption_secret_id (String, nil) (defaults to: nil) 


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'dms/cfn_data_provider.rb', line 1104

def initialize(database_name:, port:, server_name:, ssl_mode:, asm_server: nil, certificate_arn: nil, secrets_manager_oracle_asm_access_role_arn: nil, secrets_manager_oracle_asm_secret_id: nil, secrets_manager_security_db_encryption_access_role_arn: nil, secrets_manager_security_db_encryption_secret_id: 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")
  @asm_server = asm_server
  Jsii::Type.check_type(@asm_server, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "asmServer") unless @asm_server.nil?
  @certificate_arn = certificate_arn
  Jsii::Type.check_type(@certificate_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateArn") unless @certificate_arn.nil?
  @secrets_manager_oracle_asm_access_role_arn = secrets_manager_oracle_asm_access_role_arn
  Jsii::Type.check_type(@secrets_manager_oracle_asm_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerOracleAsmAccessRoleArn") unless @secrets_manager_oracle_asm_access_role_arn.nil?
  @secrets_manager_oracle_asm_secret_id = secrets_manager_oracle_asm_secret_id
  Jsii::Type.check_type(@secrets_manager_oracle_asm_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerOracleAsmSecretId") unless @secrets_manager_oracle_asm_secret_id.nil?
  @secrets_manager_security_db_encryption_access_role_arn = secrets_manager_security_db_encryption_access_role_arn
  Jsii::Type.check_type(@secrets_manager_security_db_encryption_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerSecurityDbEncryptionAccessRoleArn") unless @secrets_manager_security_db_encryption_access_role_arn.nil?
  @secrets_manager_security_db_encryption_secret_id = secrets_manager_security_db_encryption_secret_id
  Jsii::Type.check_type(@secrets_manager_security_db_encryption_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerSecurityDbEncryptionSecretId") unless @secrets_manager_security_db_encryption_secret_id.nil?
end

Instance Attribute Details

#asm_server ⇒ String? (readonly)

For an Oracle source endpoint, your ASM server address.

You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database .

Returns:

  • (String, nil)

See Also:



1153
1154
1155
 
# File 'dms/cfn_data_provider.rb', line 1153

def asm_server
  @asm_server
end

#certificate_arn ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1156
1157
1158
 
# File 'dms/cfn_data_provider.rb', line 1156

def certificate_arn
  @certificate_arn
end

#database_name ⇒ String (readonly)

Database name for the endpoint.

Returns:

  • (String)

See Also:



1131
1132
1133
 
# File 'dms/cfn_data_provider.rb', line 1131

def database_name
  @database_name
end

#port ⇒ Numeric (readonly)

Endpoint TCP port.

Returns:

  • (Numeric)

See Also:



1136
1137
1138
 
# File 'dms/cfn_data_provider.rb', line 1136

def port
  @port
end

#secrets_manager_oracle_asm_access_role_arn ⇒ String? (readonly)

Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret . This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId . Or you can specify clear-text values for AsmUser , AsmPassword , and AsmServerName . You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



1165
1166
1167
 
# File 'dms/cfn_data_provider.rb', line 1165

def secrets_manager_oracle_asm_access_role_arn
  @secrets_manager_oracle_asm_access_role_arn
end

#secrets_manager_oracle_asm_secret_id ⇒ String? (readonly)

Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

Returns:

  • (String, nil)

See Also:



1172
1173
1174
 
# File 'dms/cfn_data_provider.rb', line 1172

def secrets_manager_oracle_asm_secret_id
  @secrets_manager_oracle_asm_secret_id
end

#secrets_manager_security_db_encryption_access_role_arn ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1175
1176
1177
 
# File 'dms/cfn_data_provider.rb', line 1175

def secrets_manager_security_db_encryption_access_role_arn
  @secrets_manager_security_db_encryption_access_role_arn
end

#secrets_manager_security_db_encryption_secret_id ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1178
1179
1180
 
# File 'dms/cfn_data_provider.rb', line 1178

def secrets_manager_security_db_encryption_secret_id
  @secrets_manager_security_db_encryption_secret_id
end

#server_name ⇒ String (readonly)

Fully qualified domain name of the endpoint.

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

Returns:

  • (String)

See Also:



1143
1144
1145
 
# File 'dms/cfn_data_provider.rb', line 1143

def server_name
  @server_name
end

#ssl_mode ⇒ String (readonly)

Returns:

  • (String)

See Also:



1146
1147
1148
 
# File 'dms/cfn_data_provider.rb', line 1146

def ssl_mode
  @ssl_mode
end

Class Method Details

.jsii_properties ⇒ Object 



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'dms/cfn_data_provider.rb', line 1180

def self.jsii_properties
  {
    :database_name => "databaseName",
    :port => "port",
    :server_name => "serverName",
    :ssl_mode => "sslMode",
    :asm_server => "asmServer",
    :certificate_arn => "certificateArn",
    :secrets_manager_oracle_asm_access_role_arn => "secretsManagerOracleAsmAccessRoleArn",
    :secrets_manager_oracle_asm_secret_id => "secretsManagerOracleAsmSecretId",
    :secrets_manager_security_db_encryption_access_role_arn => "secretsManagerSecurityDbEncryptionAccessRoleArn",
    :secrets_manager_security_db_encryption_secret_id => "secretsManagerSecurityDbEncryptionSecretId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'dms/cfn_data_provider.rb', line 1195

def to_jsii
  result = {}
  result.merge!({
    "databaseName" => @database_name,
    "port" => @port,
    "serverName" => @server_name,
    "sslMode" => @ssl_mode,
    "asmServer" => @asm_server,
    "certificateArn" => @certificate_arn,
    "secretsManagerOracleAsmAccessRoleArn" => @secrets_manager_oracle_asm_access_role_arn,
    "secretsManagerOracleAsmSecretId" => @secrets_manager_oracle_asm_secret_id,
    "secretsManagerSecurityDbEncryptionAccessRoleArn" => @secrets_manager_security_db_encryption_access_role_arn,
    "secretsManagerSecurityDbEncryptionSecretId" => @secrets_manager_security_db_encryption_secret_id,
  })
  result.compact
end