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

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

Overview

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

  • CreateEndpoint

  • DescribeEndpoint

  • ModifyEndpoint

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The name of the database at the endpoint.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#dms_transfer_settingsTypes::DmsTransferSettings

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#doc_db_settingsTypes::DocDbSettings

Provides information that defines a DocumentDB endpoint.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#dynamo_db_settingsTypes::DynamoDbSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_settingsTypes::ElasticsearchSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_arnString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_identifierString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_typeString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#engine_display_nameString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#engine_nameString

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#external_idString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#external_table_definitionString

The external table definition.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#extra_connection_attributesString

Additional connection attributes used to connect to the endpoint.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#gcp_my_sql_settingsTypes::GcpMySQLSettings

Settings in JSON format for the source GCP MySQL endpoint.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#ibm_db_2_settingsTypes::IBMDb2Settings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#is_read_onlyBoolean

Indicates whether the endpoint is read-only. When set to true, this endpoint is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only endpoints through their associated zero-ETL integration.

Returns:

  • (Boolean)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kafka_settingsTypes::KafkaSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_settingsTypes::KinesisSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  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)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#lakehouse_settingsTypes::LakehouseSettings

Settings in JSON format for the target Lakehouse endpoint. This parameter applies to endpoints that are automatically created by DMS for a Lakehouse data warehouse as part of a zero-ETL integration.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#microsoft_sql_server_settingsTypes::MicrosoftSQLServerSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#mongo_db_settingsTypes::MongoDbSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#my_sql_settingsTypes::MySQLSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#neptune_settingsTypes::NeptuneSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#oracle_settingsTypes::OracleSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port value used to access the endpoint.

Returns:

  • (Integer)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#postgre_sql_settingsTypes::PostgreSQLSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#redis_settingsTypes::RedisSettings

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_settingsTypes::RedshiftSettings

Settings for the Amazon Redshift endpoint.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#s3_settingsTypes::S3Settings

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

Returns:



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#server_nameString

The name of the server at the endpoint.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_role_arnString

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_modeString

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

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the endpoint.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#sybase_settingsTypes::SybaseSettings

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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#timestream_settingsTypes::TimestreamSettings

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end

#usernameString

The user name used to connect to the endpoint.

Returns:

  • (String)


6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6044

class Endpoint < Struct.new(
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :engine_display_name,
  :username,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :status,
  :kms_key_id,
  :endpoint_arn,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :external_id,
  :is_read_only,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :kafka_settings,
  :elasticsearch_settings,
  :neptune_settings,
  :redshift_settings,
  :postgre_sql_settings,
  :my_sql_settings,
  :oracle_settings,
  :sybase_settings,
  :microsoft_sql_server_settings,
  :ibm_db_2_settings,
  :doc_db_settings,
  :redis_settings,
  :gcp_my_sql_settings,
  :timestream_settings,
  :lakehouse_settings)
  SENSITIVE = []
  include Aws::Structure
end