You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DatabaseMigrationService::Types::CreateEndpointMessage

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 CreateEndpointMessage data as a hash:

{
  endpoint_identifier: "String", # required
  endpoint_type: "source", # required, accepts source, target
  engine_name: "String", # required
  username: "String",
  password: "SecretString",
  server_name: "String",
  port: 1,
  database_name: "String",
  extra_connection_attributes: "String",
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  certificate_arn: "String",
  ssl_mode: "none", # accepts none, require, verify-ca, verify-full
  dynamo_db_settings: {
    service_access_role_arn: "String", # required
  },
  s3_settings: {
    service_access_role_arn: "String",
    external_table_definition: "String",
    csv_row_delimiter: "String",
    csv_delimiter: "String",
    bucket_folder: "String",
    bucket_name: "String",
    compression_type: "none", # accepts none, gzip
  },
  mongo_db_settings: {
    username: "String",
    password: "SecretString",
    server_name: "String",
    port: 1,
    database_name: "String",
    auth_type: "no", # accepts no, password
    auth_mechanism: "default", # accepts default, mongodb_cr, scram_sha_1
    nesting_level: "none", # accepts none, one
    extract_doc_id: "String",
    docs_to_investigate: "String",
    auth_source: "String",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

The Amazon Resource Number (ARN) for the certificate.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#database_nameString

The name of the endpoint database.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#dynamo_db_settingsTypes::DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#endpoint_identifierString

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#endpoint_typeString

The type of endpoint.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#engine_nameString

The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#extra_connection_attributesString

Additional attributes associated with the connection.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#kms_key_idString

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#mongo_db_settingsTypes::MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#passwordString

The password to be used to login to the endpoint database.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#portInteger

The port used by the endpoint database.

Returns:

  • (Integer)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#s3_settingsTypes::S3Settings

Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#server_nameString

The name of the server where the endpoint database resides.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#ssl_modeString

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags to be added to the endpoint.

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#usernameString

The user name to be used to login to the endpoint database.

Returns:

  • (String)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 334

class CreateEndpointMessage < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :kms_key_id,
  :tags,
  :certificate_arn,
  :ssl_mode,
  :dynamo_db_settings,
  :s3_settings,
  :mongo_db_settings)
  include Aws::Structure
end