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

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

Overview

Note:

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

{
  endpoint_identifier: "String", # required
  endpoint_type: "source", # required, accepts source, target
  engine_name: "String", # required
  username: "String",
  password: "SecretString",
  server_name: "String",
  port: 1,
  database_name: "String",
  extra_connection_attributes: "String",
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
      resource_arn: "String",
    },
  ],
  certificate_arn: "String",
  ssl_mode: "none", # accepts none, require, verify-ca, verify-full
  service_access_role_arn: "String",
  external_table_definition: "String",
  dynamo_db_settings: {
    service_access_role_arn: "String", # required
  },
  s3_settings: {
    service_access_role_arn: "String",
    external_table_definition: "String",
    csv_row_delimiter: "String",
    csv_delimiter: "String",
    bucket_folder: "String",
    bucket_name: "String",
    compression_type: "none", # accepts none, gzip
    encryption_mode: "sse-s3", # accepts sse-s3, sse-kms
    server_side_encryption_kms_key_id: "String",
    data_format: "csv", # accepts csv, parquet
    encoding_type: "plain", # accepts plain, plain-dictionary, rle-dictionary
    dict_page_size_limit: 1,
    row_group_length: 1,
    data_page_size: 1,
    parquet_version: "parquet-1-0", # accepts parquet-1-0, parquet-2-0
    enable_statistics: false,
    include_op_for_full_load: false,
    cdc_inserts_only: false,
    timestamp_column_name: "String",
    parquet_timestamp_in_millisecond: false,
    cdc_inserts_and_updates: false,
    date_partition_enabled: false,
    date_partition_sequence: "YYYYMMDD", # accepts YYYYMMDD, YYYYMMDDHH, YYYYMM, MMYYYYDD, DDMMYYYY
    date_partition_delimiter: "SLASH", # accepts SLASH, UNDERSCORE, DASH, NONE
    use_csv_no_sup_value: false,
    csv_no_sup_value: "String",
    preserve_transactions: false,
    cdc_path: "String",
    canned_acl_for_objects: "none", # accepts none, private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
    add_column_name: false,
    cdc_max_batch_interval: 1,
    cdc_min_file_size: 1,
    csv_null_value: "String",
    ignore_header_rows: 1,
    max_file_size: 1,
    rfc_4180: false,
  },
  dms_transfer_settings: {
    service_access_role_arn: "String",
    bucket_name: "String",
  },
  mongo_db_settings: {
    username: "String",
    password: "SecretString",
    server_name: "String",
    port: 1,
    database_name: "String",
    auth_type: "no", # accepts no, password
    auth_mechanism: "default", # accepts default, mongodb_cr, scram_sha_1
    nesting_level: "none", # accepts none, one
    extract_doc_id: "String",
    docs_to_investigate: "String",
    auth_source: "String",
    kms_key_id: "String",
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  kinesis_settings: {
    stream_arn: "String",
    message_format: "json", # accepts json, json-unformatted
    service_access_role_arn: "String",
    include_transaction_details: false,
    include_partition_value: false,
    partition_include_schema_table: false,
    include_table_alter_operations: false,
    include_control_details: false,
    include_null_and_empty: false,
    no_hex_prefix: false,
  },
  kafka_settings: {
    broker: "String",
    topic: "String",
    message_format: "json", # accepts json, json-unformatted
    include_transaction_details: false,
    include_partition_value: false,
    partition_include_schema_table: false,
    include_table_alter_operations: false,
    include_control_details: false,
    message_max_bytes: 1,
    include_null_and_empty: false,
    security_protocol: "plaintext", # accepts plaintext, ssl-authentication, ssl-encryption, sasl-ssl
    ssl_client_certificate_arn: "String",
    ssl_client_key_arn: "String",
    ssl_client_key_password: "SecretString",
    ssl_ca_certificate_arn: "String",
    sasl_username: "String",
    sasl_password: "SecretString",
    no_hex_prefix: false,
  },
  elasticsearch_settings: {
    service_access_role_arn: "String", # required
    endpoint_uri: "String", # required
    full_load_error_percentage: 1,
    error_retry_duration: 1,
  },
  neptune_settings: {
    service_access_role_arn: "String",
    s3_bucket_name: "String", # required
    s3_bucket_folder: "String", # required
    error_retry_duration: 1,
    max_file_size: 1,
    max_retry_count: 1,
    iam_auth_enabled: false,
  },
  redshift_settings: {
    accept_any_date: false,
    after_connect_script: "String",
    bucket_folder: "String",
    bucket_name: "String",
    case_sensitive_names: false,
    comp_update: false,
    connection_timeout: 1,
    database_name: "String",
    date_format: "String",
    empty_as_null: false,
    encryption_mode: "sse-s3", # accepts sse-s3, sse-kms
    explicit_ids: false,
    file_transfer_upload_streams: 1,
    load_timeout: 1,
    max_file_size: 1,
    password: "SecretString",
    port: 1,
    remove_quotes: false,
    replace_invalid_chars: "String",
    replace_chars: "String",
    server_name: "String",
    service_access_role_arn: "String",
    server_side_encryption_kms_key_id: "String",
    time_format: "String",
    trim_blanks: false,
    truncate_columns: false,
    username: "String",
    write_buffer_size: 1,
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  postgre_sql_settings: {
    after_connect_script: "String",
    capture_ddls: false,
    max_file_size: 1,
    database_name: "String",
    ddl_artifacts_schema: "String",
    execute_timeout: 1,
    fail_tasks_on_lob_truncation: false,
    heartbeat_enable: false,
    heartbeat_schema: "String",
    heartbeat_frequency: 1,
    password: "SecretString",
    port: 1,
    server_name: "String",
    username: "String",
    slot_name: "String",
    plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  my_sql_settings: {
    after_connect_script: "String",
    clean_source_metadata_on_mismatch: false,
    database_name: "String",
    events_poll_interval: 1,
    target_db_type: "specific-database", # accepts specific-database, multiple-databases
    max_file_size: 1,
    parallel_load_threads: 1,
    password: "SecretString",
    port: 1,
    server_name: "String",
    server_timezone: "String",
    username: "String",
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  oracle_settings: {
    add_supplemental_logging: false,
    archived_log_dest_id: 1,
    additional_archived_log_dest_id: 1,
    extra_archived_log_dest_ids: [1],
    allow_select_nested_tables: false,
    parallel_asm_read_threads: 1,
    read_ahead_blocks: 1,
    access_alternate_directly: false,
    use_alternate_folder_for_online: false,
    oracle_path_prefix: "String",
    use_path_prefix: "String",
    replace_path_prefix: false,
    enable_homogenous_tablespace: false,
    direct_path_no_log: false,
    archived_logs_only: false,
    asm_password: "SecretString",
    asm_server: "String",
    asm_user: "String",
    char_length_semantics: "default", # accepts default, char, byte
    database_name: "String",
    direct_path_parallel_load: false,
    fail_tasks_on_lob_truncation: false,
    number_datatype_scale: 1,
    password: "SecretString",
    port: 1,
    read_table_space_name: false,
    retry_interval: 1,
    security_db_encryption: "SecretString",
    security_db_encryption_name: "String",
    server_name: "String",
    spatial_data_option_to_geo_json_function_name: "String",
    standby_delay_time: 1,
    username: "String",
    use_b_file: false,
    use_direct_path_full_load: false,
    use_logminer_reader: false,
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
    secrets_manager_oracle_asm_access_role_arn: "String",
    secrets_manager_oracle_asm_secret_id: "String",
  },
  sybase_settings: {
    database_name: "String",
    password: "SecretString",
    port: 1,
    server_name: "String",
    username: "String",
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  microsoft_sql_server_settings: {
    port: 1,
    bcp_packet_size: 1,
    database_name: "String",
    control_tables_file_group: "String",
    password: "SecretString",
    query_single_always_on_node: false,
    read_backup_only: false,
    safeguard_policy: "rely-on-sql-server-replication-agent", # accepts rely-on-sql-server-replication-agent, exclusive-automatic-truncation, shared-automatic-truncation
    server_name: "String",
    username: "String",
    use_bcp_full_load: false,
    use_third_party_backup_device: false,
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  ibm_db_2_settings: {
    database_name: "String",
    password: "SecretString",
    port: 1,
    server_name: "String",
    set_data_capture_changes: false,
    current_lsn: "String",
    max_k_bytes_per_read: 1,
    username: "String",
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  resource_identifier: "String",
  doc_db_settings: {
    username: "String",
    password: "SecretString",
    server_name: "String",
    port: 1,
    database_name: "String",
    nesting_level: "none", # accepts none, one
    extract_doc_id: false,
    docs_to_investigate: 1,
    kms_key_id: "String",
    secrets_manager_access_role_arn: "String",
    secrets_manager_secret_id: "String",
  },
  redis_settings: {
    server_name: "String", # required
    port: 1, # required
    ssl_security_protocol: "plaintext", # accepts plaintext, ssl-encryption
    auth_type: "none", # accepts none, auth-role, auth-token
    auth_user_name: "String",
    auth_password: "SecretString",
    ssl_ca_certificate_arn: "String",
  },
}

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

The Amazon Resource Name (ARN) for the certificate.

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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", \}



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#doc_db_settingsTypes::DocDbSettings

Provides information that defines a DocumentDB endpoint.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#elasticsearch_settingsTypes::ElasticsearchSettings

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



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#endpoint_typeString

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

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune".

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#external_table_definitionString

The external table definition.

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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 in the Database Migration Service User Guide.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

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

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

The port used by the endpoint database.

Returns:

  • (Integer)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#redis_settingsTypes::RedisSettings

Settings in JSON format for the target Redis endpoint.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#redshift_settingsTypes::RedshiftSettings

Provides information that defines an Amazon Redshift endpoint.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.

Returns:



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

The name of the server where the endpoint database resides.

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tags to be assigned to the endpoint.

Returns:



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 920

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)
  SENSITIVE = [:password]
  include Aws::Structure
end