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

Inherits:

Struct

Object
Struct
Aws::DatabaseMigrationService::Types::Endpoint

show all

Defined in:: gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

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

CreateEndpoint
DescribeEndpoint
ModifyEndpoint

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#certificate_arn ⇒ String
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
#database_name ⇒ String
The name of the database at the endpoint.
#dms_transfer_settings ⇒ Types::DmsTransferSettings
The settings for the DMS Transfer type source.
#doc_db_settings ⇒ Types::DocDbSettings
Provides information that defines a DocumentDB endpoint.
#dynamo_db_settings ⇒ Types::DynamoDbSettings
The settings for the DynamoDB target endpoint.
#elasticsearch_settings ⇒ Types::ElasticsearchSettings
The settings for the OpenSearch source endpoint.
#endpoint_arn ⇒ String
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
#endpoint_identifier ⇒ String
The database endpoint identifier.
#endpoint_type ⇒ String
The type of endpoint.
#engine_display_name ⇒ String
The expanded name for the engine name.
#engine_name ⇒ String
The database engine name.
#external_id ⇒ String
Value returned by a call to CreateEndpoint that can be used for cross-account validation.
#external_table_definition ⇒ String
The external table definition.
#extra_connection_attributes ⇒ String
Additional connection attributes used to connect to the endpoint.
#gcp_my_sql_settings ⇒ Types::GcpMySQLSettings
Settings in JSON format for the source GCP MySQL endpoint.
#ibm_db_2_settings ⇒ Types::IBMDb2Settings
The settings for the IBM Db2 LUW source endpoint.
#is_read_only ⇒ Boolean
Indicates whether the endpoint is read-only.
#kafka_settings ⇒ Types::KafkaSettings
The settings for the Apache Kafka target endpoint.
#kinesis_settings ⇒ Types::KinesisSettings
The settings for the Amazon Kinesis target endpoint.
#kms_key_id ⇒ String
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
#lakehouse_settings ⇒ Types::LakehouseSettings
Settings in JSON format for the target Lakehouse endpoint.
#microsoft_sql_server_settings ⇒ Types::MicrosoftSQLServerSettings
The settings for the Microsoft SQL Server source and target endpoint.
#mongo_db_settings ⇒ Types::MongoDbSettings
The settings for the MongoDB source endpoint.
#my_sql_settings ⇒ Types::MySQLSettings
The settings for the MySQL source and target endpoint.
#neptune_settings ⇒ Types::NeptuneSettings
The settings for the Amazon Neptune target endpoint.
#oracle_settings ⇒ Types::OracleSettings
The settings for the Oracle source and target endpoint.
#port ⇒ Integer
The port value used to access the endpoint.
#postgre_sql_settings ⇒ Types::PostgreSQLSettings
The settings for the PostgreSQL source and target endpoint.
#redis_settings ⇒ Types::RedisSettings
The settings for the Redis target endpoint.
#redshift_settings ⇒ Types::RedshiftSettings
Settings for the Amazon Redshift endpoint.
#s3_settings ⇒ Types::S3Settings
The settings for the S3 target endpoint.
#server_name ⇒ String
The name of the server at the endpoint.
#service_access_role_arn ⇒ String
The Amazon Resource Name (ARN) used by the service to access the IAM role.
#ssl_mode ⇒ String
The SSL mode used to connect to the endpoint.
#status ⇒ String
The status of the endpoint.
#sybase_settings ⇒ Types::SybaseSettings
The settings for the SAP ASE source and target endpoint.
#timestream_settings ⇒ Types::TimestreamSettings
The settings for the Amazon Timestream target endpoint.
#username ⇒ String
The user name used to connect to the endpoint.

Instance Attribute Details

#certificate_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_name ⇒ `String`

The name of the database at the endpoint.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::DmsTransferSettings`

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

Returns:

(Types::DmsTransferSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::DocDbSettings`

Provides information that defines a DocumentDB endpoint.

Returns:

(Types::DocDbSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::DynamoDbSettings`

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

Returns:

(Types::DynamoDbSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::ElasticsearchSettings`

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

Returns:

(Types::ElasticsearchSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_identifier ⇒ `String`

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_type ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_name ⇒ `String`

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_id ⇒ `String`

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_definition ⇒ `String`

The external table definition.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_attributes ⇒ `String`

Additional connection attributes used to connect to the endpoint.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::GcpMySQLSettings`

Settings in JSON format for the source GCP MySQL endpoint.

Returns:

(Types::GcpMySQLSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::IBMDb2Settings`

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

Returns:

(Types::IBMDb2Settings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_only ⇒ `Boolean`

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::KafkaSettings`

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

Returns:

(Types::KafkaSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::KinesisSettings`

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

Returns:

(Types::KinesisSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_id ⇒ `String`

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::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.

Returns:

(Types::LakehouseSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::MicrosoftSQLServerSettings`

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

Returns:

(Types::MicrosoftSQLServerSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::MongoDbSettings`

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

Returns:

(Types::MongoDbSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::MySQLSettings`

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

Returns:

(Types::MySQLSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::NeptuneSettings`

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

Returns:

(Types::NeptuneSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::OracleSettings`

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

Returns:

(Types::OracleSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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

#port ⇒ `Integer`

The port value used to access the endpoint.

Returns:

(Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::PostgreSQLSettings`

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

Returns:

(Types::PostgreSQLSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::RedisSettings`

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

Returns:

(Types::RedisSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::RedshiftSettings`

Settings for the Amazon Redshift endpoint.

Returns:

(Types::RedshiftSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::S3Settings`

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

Returns:

(Types::S3Settings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_name ⇒ `String`

The name of the server at the endpoint.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_mode ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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

#status ⇒ `String`

The status of the endpoint.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::SybaseSettings`

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

Returns:

(Types::SybaseSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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_settings ⇒ `Types::TimestreamSettings`

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

Returns:

(Types::TimestreamSettings)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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

#username ⇒ `String`

The user name used to connect to the endpoint.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5909

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

#database_name ⇒ String

#dms_transfer_settings ⇒ Types::DmsTransferSettings

#doc_db_settings ⇒ Types::DocDbSettings

#dynamo_db_settings ⇒ Types::DynamoDbSettings

#elasticsearch_settings ⇒ Types::ElasticsearchSettings

#endpoint_arn ⇒ String

#endpoint_identifier ⇒ String

#endpoint_type ⇒ String

#engine_display_name ⇒ String

#engine_name ⇒ String

#external_id ⇒ String

#external_table_definition ⇒ String

#extra_connection_attributes ⇒ String

#gcp_my_sql_settings ⇒ Types::GcpMySQLSettings

#ibm_db_2_settings ⇒ Types::IBMDb2Settings

#is_read_only ⇒ Boolean

#kafka_settings ⇒ Types::KafkaSettings

#kinesis_settings ⇒ Types::KinesisSettings

#kms_key_id ⇒ String

#lakehouse_settings ⇒ Types::LakehouseSettings

#microsoft_sql_server_settings ⇒ Types::MicrosoftSQLServerSettings

#mongo_db_settings ⇒ Types::MongoDbSettings

#my_sql_settings ⇒ Types::MySQLSettings

#neptune_settings ⇒ Types::NeptuneSettings

#oracle_settings ⇒ Types::OracleSettings

#port ⇒ Integer

#postgre_sql_settings ⇒ Types::PostgreSQLSettings

#redis_settings ⇒ Types::RedisSettings

#redshift_settings ⇒ Types::RedshiftSettings

#s3_settings ⇒ Types::S3Settings

#server_name ⇒ String

#service_access_role_arn ⇒ String

#ssl_mode ⇒ String

#status ⇒ String

#sybase_settings ⇒ Types::SybaseSettings

#timestream_settings ⇒ Types::TimestreamSettings

#username ⇒ String

#certificate_arn ⇒ `String`

#database_name ⇒ `String`

#dms_transfer_settings ⇒ `Types::DmsTransferSettings`

#doc_db_settings ⇒ `Types::DocDbSettings`

#dynamo_db_settings ⇒ `Types::DynamoDbSettings`

#elasticsearch_settings ⇒ `Types::ElasticsearchSettings`

#endpoint_arn ⇒ `String`

#endpoint_identifier ⇒ `String`

#endpoint_type ⇒ `String`

#engine_display_name ⇒ `String`

#engine_name ⇒ `String`

#external_id ⇒ `String`

#external_table_definition ⇒ `String`

#extra_connection_attributes ⇒ `String`

#gcp_my_sql_settings ⇒ `Types::GcpMySQLSettings`

#ibm_db_2_settings ⇒ `Types::IBMDb2Settings`

#is_read_only ⇒ `Boolean`

#kafka_settings ⇒ `Types::KafkaSettings`

#kinesis_settings ⇒ `Types::KinesisSettings`

#kms_key_id ⇒ `String`

#lakehouse_settings ⇒ `Types::LakehouseSettings`

#microsoft_sql_server_settings ⇒ `Types::MicrosoftSQLServerSettings`

#mongo_db_settings ⇒ `Types::MongoDbSettings`

#my_sql_settings ⇒ `Types::MySQLSettings`

#neptune_settings ⇒ `Types::NeptuneSettings`

#oracle_settings ⇒ `Types::OracleSettings`

#port ⇒ `Integer`

#postgre_sql_settings ⇒ `Types::PostgreSQLSettings`

#redis_settings ⇒ `Types::RedisSettings`

#redshift_settings ⇒ `Types::RedshiftSettings`

#s3_settings ⇒ `Types::S3Settings`

#server_name ⇒ `String`

#service_access_role_arn ⇒ `String`

#ssl_mode ⇒ `String`

#status ⇒ `String`

#sybase_settings ⇒ `Types::SybaseSettings`

#timestream_settings ⇒ `Types::TimestreamSettings`

#username ⇒ `String`