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

Inherits:

Struct

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

Defined in:

(unknown)

Overview

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

• CreateEndpoint

• DescribeEndpoint

• DescribeEndpointTypes

• ModifyEndpoint

Returned by:

• CreateEndpointResponse#endpoint
• DeleteEndpointResponse#endpoint
• ModifyEndpointResponse#endpoint

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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 in JSON format for the DMS transfer type of source endpoint.

• #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 Elasticsearch 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.

• #ibm_db_2_settings ⇒ Types::IBMDb2Settings

  The settings for the IBM Db2 LUW source endpoint.

• #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 AWS KMS key identifier that is used to encrypt the connection parameters for the 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.

• #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 access 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.

• #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) —

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

#database_name ⇒ String

The name of the database at the endpoint.

Returns:

• (String) —

  The name of the database at the endpoint.

#dms_transfer_settings ⇒ Types::DmsTransferSettings

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.

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

• CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don\'t use this value.

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

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

Returns:

• (Types::DmsTransferSettings) —

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

#doc_db_settings ⇒ Types::DocDbSettings

Provides information that defines a DocumentDB endpoint.

Returns:

• (Types::DocDbSettings) —

  Provides information that defines a DocumentDB endpoint.

  .

#dynamo_db_settings ⇒ Types::DynamoDbSettings

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

Returns:

• (Types::DynamoDbSettings) —

  The settings for the DynamoDB target endpoint.

#elasticsearch_settings ⇒ Types::ElasticsearchSettings

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

Returns:

• (Types::ElasticsearchSettings) —

  The settings for the Elasticsearch source endpoint.

#endpoint_arn ⇒ String

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

Returns:

• (String) —

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

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

  The database endpoint identifier.

#endpoint_type ⇒ String

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

Possible values:

• source
• target

Returns:

• (String) —

  The type of endpoint.

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

  The expanded name for the engine name.

#engine_name ⇒ String

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

Returns:

• (String) —

  The database engine name.

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

  Value returned by a call to CreateEndpoint that can be used for cross-account validation.

#external_table_definition ⇒ String

The external table definition.

Returns:

• (String) —

  The external table definition.

#extra_connection_attributes ⇒ String

Additional connection attributes used to connect to the endpoint.

Returns:

• (String) —

  Additional connection attributes used to connect to the endpoint.

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

  The settings for the IBM Db2 LUW source endpoint.

#kafka_settings ⇒ Types::KafkaSettings

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

Returns:

• (Types::KafkaSettings) —

  The settings for the Apache Kafka target endpoint.

#kinesis_settings ⇒ Types::KinesisSettings

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

Returns:

• (Types::KinesisSettings) —

  The settings for the Amazon Kinesis target endpoint.

#kms_key_id ⇒ String

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

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

Returns:

• (String) —

  An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

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

  The settings for the Microsoft SQL Server source and target endpoint.

#mongo_db_settings ⇒ Types::MongoDbSettings

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

Returns:

• (Types::MongoDbSettings) —

  The settings for the MongoDB source endpoint.

#my_sql_settings ⇒ Types::MySQLSettings

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

Returns:

• (Types::MySQLSettings) —

  The settings for the MySQL source and target endpoint.

#neptune_settings ⇒ Types::NeptuneSettings

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

Returns:

• (Types::NeptuneSettings) —

  The settings for the Amazon Neptune target endpoint.

#oracle_settings ⇒ Types::OracleSettings

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

Returns:

• (Types::OracleSettings) —

  The settings for the Oracle source and target endpoint.

#port ⇒ Integer

The port value used to access the endpoint.

Returns:

• (Integer) —

  The port value used to access the endpoint.

#postgre_sql_settings ⇒ Types::PostgreSQLSettings

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

Returns:

• (Types::PostgreSQLSettings) —

  The settings for the PostgreSQL source and target endpoint.

#redshift_settings ⇒ Types::RedshiftSettings

Settings for the Amazon Redshift endpoint.

Returns:

• (Types::RedshiftSettings) —

  Settings for the Amazon Redshift endpoint.

#s3_settings ⇒ Types::S3Settings

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

Returns:

• (Types::S3Settings) —

  The settings for the S3 target endpoint.

#server_name ⇒ String

The name of the server at the endpoint.

Returns:

• (String) —

  The name of the server at the endpoint.

#service_access_role_arn ⇒ String

The Amazon Resource Name (ARN) used by the service access IAM role.

Returns:

• (String) —

  The Amazon Resource Name (ARN) used by the service access IAM role.

#ssl_mode ⇒ String

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

Possible values:

• none
• require
• verify-ca
• verify-full

Returns:

• (String) —

  The SSL mode used to connect to the endpoint.

#status ⇒ String

The status of the endpoint.

Returns:

• (String) —

  The status of the endpoint.

#sybase_settings ⇒ Types::SybaseSettings

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

Returns:

• (Types::SybaseSettings) —

  The settings for the SAP ASE source and target endpoint.

#username ⇒ String

The user name used to connect to the endpoint.

Returns:

• (String) —

  The user name used to connect to the endpoint.