You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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:

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

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_nameString

The name of the database at the endpoint.

Returns:

  • (String)

    The name of the database at the endpoint.

#dms_transfer_settingsTypes::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:

#dynamo_db_settingsTypes::DynamoDbSettings

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

Returns:

#elasticsearch_settingsTypes::ElasticsearchSettings

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

Returns:

#endpoint_arnString

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

    The database endpoint identifier.

#endpoint_typeString

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

Possible values:

  • source
  • target

Returns:

  • (String)

    The type of endpoint.

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

    The expanded name for the engine name.

#engine_nameString

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

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

#external_table_definitionString

The external table definition.

Returns:

  • (String)

    The external table definition.

#extra_connection_attributesString

Additional connection attributes used to connect to the endpoint.

Returns:

  • (String)

    Additional connection attributes used to connect to the endpoint.

#ibm_db_2_settingsTypes::IBMDb2Settings

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

Returns:

#kafka_settingsTypes::KafkaSettings

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

Returns:

#kinesis_settingsTypes::KinesisSettings

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

Returns:

#kms_key_idString

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_settingsTypes::MicrosoftSQLServerSettings

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

Returns:

#mongo_db_settingsTypes::MongoDbSettings

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

Returns:

#my_sql_settingsTypes::MySQLSettings

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

Returns:

#neptune_settingsTypes::NeptuneSettings

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

Returns:

#oracle_settingsTypes::OracleSettings

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

Returns:

#portInteger

The port value used to access the endpoint.

Returns:

  • (Integer)

    The port value used to access the endpoint.

#postgre_sql_settingsTypes::PostgreSQLSettings

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

Returns:

#redshift_settingsTypes::RedshiftSettings

Settings for the Amazon Redshift endpoint.

Returns:

#s3_settingsTypes::S3Settings

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

Returns:

#server_nameString

The name of the server at the endpoint.

Returns:

  • (String)

    The name of the server at the endpoint.

#service_access_role_arnString

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_modeString

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.

#statusString

The status of the endpoint.

Returns:

  • (String)

    The status of the endpoint.

#sybase_settingsTypes::SybaseSettings

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

Returns:

#usernameString

The user name used to connect to the endpoint.

Returns:

  • (String)

    The user name used to connect to the endpoint.