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

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

Overview

Describes an endpoint of a database instance in response to operations such as the following:

  • CreateEndpoint

  • DescribeEndpoint

  • DescribeEndpointTypes

  • ModifyEndpoint

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

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

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The name of the database at the endpoint.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#dms_transfer_settingsTypes::DmsTransferSettings

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

Possible settings include the following:

  • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these settings is as follows: \{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" \}



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#doc_db_settingsTypes::DocDbSettings

Provides information that defines a DocumentDB endpoint.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#dynamo_db_settingsTypes::DynamoDbSettings

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



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_settingsTypes::ElasticsearchSettings

The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_arnString

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

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_identifierString

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

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_typeString

The type of endpoint. Valid values are source and target.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  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)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  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", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  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)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#external_table_definitionString

The external table definition.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#extra_connection_attributesString

Additional connection attributes used to connect to the endpoint.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#ibm_db_2_settingsTypes::IBMDb2Settings

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kafka_settingsTypes::KafkaSettings

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_settingsTypes::KinesisSettings

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#microsoft_sql_server_settingsTypes::MicrosoftSQLServerSettings

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#mongo_db_settingsTypes::MongoDbSettings

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



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#my_sql_settingsTypes::MySQLSettings

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#neptune_settingsTypes::NeptuneSettings

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#oracle_settingsTypes::OracleSettings

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port value used to access the endpoint.

Returns:

  • (Integer)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#postgre_sql_settingsTypes::PostgreSQLSettings

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_settingsTypes::RedshiftSettings

Settings for the Amazon Redshift endpoint.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#s3_settingsTypes::S3Settings

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

Returns:



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#server_nameString

The name of the server at the endpoint.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_role_arnString

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

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_modeString

The SSL mode used to connect to the endpoint. The default value is none.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the endpoint.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#sybase_settingsTypes::SybaseSettings

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end

#usernameString

The user name used to connect to the endpoint.

Returns:

  • (String)


3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3446

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,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings)
  SENSITIVE = []
  include Aws::Structure
end