class Aws::DatabaseMigrationService::Types::Endpoint

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

@!attribute [rw] endpoint_identifier

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.
@return [String]

@!attribute [rw] endpoint_type

The type of endpoint. Valid values are `source` and `target`.
@return [String]

@!attribute [rw] engine_name

The database engine name. Valid values, depending on the
EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
`"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
`"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
`"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`,
`"sqlserver"`, and `"neptune"`.
@return [String]

@!attribute [rw] engine_display_name

The expanded name for the engine name. For example, if the
`EngineName` parameter is "aurora," this value would be "Amazon
Aurora MySQL."
@return [String]

@!attribute [rw] username

The user name used to connect to the endpoint.
@return [String]

@!attribute [rw] server_name

The name of the server at the endpoint.
@return [String]

@!attribute [rw] port

The port value used to access the endpoint.
@return [Integer]

@!attribute [rw] database_name

The name of the database at the endpoint.
@return [String]

@!attribute [rw] extra_connection_attributes

Additional connection attributes used to connect to the endpoint.
@return [String]

@!attribute [rw] status

The status of the endpoint.
@return [String]

@!attribute [rw] kms_key_id

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.
@return [String]

@!attribute [rw] endpoint_arn

The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
@return [String]

@!attribute [rw] certificate_arn

The Amazon Resource Name (ARN) used for SSL connection to the
endpoint.
@return [String]

@!attribute [rw] ssl_mode

The SSL mode used to connect to the endpoint. The default value is
`none`.
@return [String]

@!attribute [rw] service_access_role_arn

The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the `iam:PassRole` action.
@return [String]

@!attribute [rw] external_table_definition

The external table definition.
@return [String]

@!attribute [rw] external_id

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.
@return [String]

@!attribute [rw] dynamo_db_settings

The settings for the DynamoDB target endpoint. For more information,
see the `DynamoDBSettings` structure.
@return [Types::DynamoDbSettings]

@!attribute [rw] s3_settings

The settings for the S3 target endpoint. For more information, see
the `S3Settings` structure.
@return [Types::S3Settings]

@!attribute [rw] dms_transfer_settings

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

Possible settings include the following:

* `ServiceAccessRoleArn` - The IAM role that has permission to
  access the Amazon S3 bucket. The role must allow the
  `iam:PassRole` action.

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

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

JSON syntax for these settings is as follows: `\{
"ServiceAccessRoleArn": "string", "BucketName": "string"\} `
@return [Types::DmsTransferSettings]

@!attribute [rw] mongo_db_settings

The settings for the MongoDB source endpoint. For more information,
see the `MongoDbSettings` structure.
@return [Types::MongoDbSettings]

@!attribute [rw] kinesis_settings

The settings for the Amazon Kinesis target endpoint. For more
information, see the `KinesisSettings` structure.
@return [Types::KinesisSettings]

@!attribute [rw] kafka_settings

The settings for the Apache Kafka target endpoint. For more
information, see the `KafkaSettings` structure.
@return [Types::KafkaSettings]

@!attribute [rw] elasticsearch_settings

The settings for the Elasticsearch source endpoint. For more
information, see the `ElasticsearchSettings` structure.
@return [Types::ElasticsearchSettings]

@!attribute [rw] neptune_settings

The settings for the Amazon Neptune target endpoint. For more
information, see the `NeptuneSettings` structure.
@return [Types::NeptuneSettings]

@!attribute [rw] redshift_settings

Settings for the Amazon Redshift endpoint.
@return [Types::RedshiftSettings]

@!attribute [rw] postgre_sql_settings

The settings for the PostgreSQL source and target endpoint. For more
information, see the `PostgreSQLSettings` structure.
@return [Types::PostgreSQLSettings]

@!attribute [rw] my_sql_settings

The settings for the MySQL source and target endpoint. For more
information, see the `MySQLSettings` structure.
@return [Types::MySQLSettings]

@!attribute [rw] oracle_settings

The settings for the Oracle source and target endpoint. For more
information, see the `OracleSettings` structure.
@return [Types::OracleSettings]

@!attribute [rw] sybase_settings

The settings for the SAP ASE source and target endpoint. For more
information, see the `SybaseSettings` structure.
@return [Types::SybaseSettings]

@!attribute [rw] microsoft_sql_server_settings

The settings for the Microsoft SQL Server source and target
endpoint. For more information, see the `MicrosoftSQLServerSettings`
structure.
@return [Types::MicrosoftSQLServerSettings]

@!attribute [rw] ibm_db_2_settings

The settings for the IBM Db2 LUW source endpoint. For more
information, see the `IBMDb2Settings` structure.
@return [Types::IBMDb2Settings]

@!attribute [rw] doc_db_settings

Provides information that defines a DocumentDB endpoint.
@return [Types::DocDbSettings]

@!attribute [rw] redis_settings

The settings for the Redis target endpoint. For more information,
see the `RedisSettings` structure.
@return [Types::RedisSettings]

@see docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/Endpoint AWS API Documentation

Constants

SENSITIVE