Class: Aws::DatabaseMigrationService::Types::IBMDb2Settings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass IBMDb2Settings data as a hash:

{
  database_name: "String",
  password: "SecretString",
  port: 1,
  server_name: "String",
  set_data_capture_changes: false,
  current_lsn: "String",
  max_k_bytes_per_read: 1,
  username: "String",
  secrets_manager_access_role_arn: "String",
  secrets_manager_secret_id: "String",
}

Provides information that defines an IBM Db2 LUW endpoint.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#current_lsnString

For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

Database name for the endpoint.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_k_bytes_per_readInteger

Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.

Returns:

  • (Integer)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

Endpoint TCP port. The default value is 50000.

Returns:

  • (Integer)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_access_role_arnString

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_idString

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#set_data_capture_changesBoolean

Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.

Returns:

  • (Boolean)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3959

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end