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

Class: Aws::DatabaseMigrationService::Types::Endpoint

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#database_nameString

The name of the database at the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#dms_transfer_settingsTypes::DmsTransferSettings

The settings in JSON format for the DMS Transfer type source endpoint.

Attributes include:

  • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

  • bucketName - The name of the S3 bucket to use.

  • compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

\{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" \}



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#dynamo_db_settingsTypes::DynamoDbSettings

The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#endpoint_arnString

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_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)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#endpoint_typeString

The type of endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#engine_display_nameString

The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#engine_nameString

The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#external_idString

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#external_table_definitionString

The external table definition.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#extra_connection_attributesString

Additional connection attributes used to connect to the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_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)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#mongo_db_settingsTypes::MongoDbSettings

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#portInteger

The port value used to access the endpoint.

Returns:

  • (Integer)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#s3_settingsTypes::S3Settings

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

Returns:



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#server_nameString

The name of the server at the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#service_access_role_arnString

The Amazon Resource Name (ARN) used by the service access IAM role.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#ssl_modeString

The SSL mode used to connect to the endpoint.

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

The default value is none.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#statusString

The status of the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end

#usernameString

The user name used to connect to the endpoint.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2218

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings)
  include Aws::Structure
end