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

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

Overview

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

The Amazon Resource Name (ARN) for the certificate.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and ‘targetDbType`.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  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 Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the `iam:PassRole` action.

  • ‘BucketName` - The name of the S3 bucket to use.

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

JSON syntax for these settings is as follows: ‘{ “ServiceAccessRoleArn”: “string”, “BucketName”: “string”, } `



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#doc_db_settingsTypes::DocDbSettings

Provides information that defines a DocumentDB endpoint.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#dynamo_db_settingsTypes::DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#elasticsearch_settingsTypes::ElasticsearchSettings

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for DMS] in the *Database Migration Service User Guide*.

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  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)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#endpoint_typeString

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

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#engine_nameString

The type of engine for the endpoint. Valid values, depending on the ‘EndpointType` value, include `“mysql”`, `“oracle”`, `“postgres”`, `“mariadb”`, `“aurora”`, `“aurora-postgresql”`, `“opensearch”`, `“redshift”`, `“s3”`, `“db2”`, `“db2-zos”`, `“azuredb”`, `“sybase”`, `“dynamodb”`, `“mongodb”`, `“kinesis”`, `“kafka”`, `“elasticsearch”`, `“docdb”`, `“sqlserver”`, `“neptune”`, `“babelfish”`, `redshift-serverless`, `aurora-serverless`, `aurora-postgresql-serverless`, `gcp-mysql`, `azure-sql-managed-instance`, `redis`, `dms-transfer`.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#external_table_definitionString

The external table definition.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#extra_connection_attributesString

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see [Working with DMS Endpoints] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#gcp_my_sql_settingsTypes::GcpMySQLSettings

Settings in JSON format for the source GCP MySQL endpoint.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#ibm_db_2_settingsTypes::IBMDb2Settings

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see [Extra connection attributes when using Db2 LUW as a source for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kafka_settingsTypes::KafkaSettings

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see [Using object mapping to migrate data to a Kafka topic] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kinesis_settingsTypes::KinesisSettings

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see

Using object mapping to migrate data to a Kinesis data stream][1

in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kms_key_idString

An 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 DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#microsoft_sql_server_settingsTypes::MicrosoftSQLServerSettings

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see [Extra connection attributes when using SQL Server as a source for DMS] and [ Extra connection attributes when using SQL Server as a target for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  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 [Endpoint configuration settings when using MongoDB as a source for Database Migration Service] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#my_sql_settingsTypes::MySQLSettings

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see [Extra connection attributes when using MySQL as a source for DMS] and [Extra connection attributes when using a MySQL-compatible database as a target for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#neptune_settingsTypes::NeptuneSettings

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see [Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#oracle_settingsTypes::OracleSettings

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see [Extra connection attributes when using Oracle as a source for DMS] and [ Extra connection attributes when using Oracle as a target for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

The password to be used to log in to the endpoint database.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

The port used by the endpoint database.

Returns:

  • (Integer)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#postgre_sql_settingsTypes::PostgreSQLSettings

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see [Extra connection attributes when using PostgreSQL as a source for DMS] and [ Extra connection attributes when using PostgreSQL as a target for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#redis_settingsTypes::RedisSettings

Settings in JSON format for the target Redis endpoint.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#redshift_settingsTypes::RedshiftSettings

Provides information that defines an Amazon Redshift endpoint.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#resource_identifierString

A friendly name for the resource identifier at the end of the ‘EndpointArn` response parameter that is returned in the created `Endpoint` object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (’-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as ‘Example-App-ARN1`. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don’t specify a ‘ResourceIdentifier` value, DMS generates a default identifier value for the end of `EndpointArn`.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#s3_settingsTypes::S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring

Returns:



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

The name of the server where the endpoint database resides.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#service_access_role_arnString

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the ‘iam:PassRole` action.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#ssl_modeString

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is ‘none`

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#sybase_settingsTypes::SybaseSettings

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see [Extra connection attributes when using SAP ASE as a source for DMS] and [Extra connection attributes when using SAP ASE as a target for DMS] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tags to be assigned to the endpoint.

Returns:



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#timestream_settingsTypes::TimestreamSettings

Settings in JSON format for the target Amazon Timestream endpoint.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

The user name to be used to log in to the endpoint database.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1018

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,
  :service_access_role_arn,
  :external_table_definition,
  :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,
  :resource_identifier,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings)
  SENSITIVE = [:password]
  include Aws::Structure
end