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

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.

#dynamo_db_settingsTypes::DynamoDbSettings

The settings for the target DynamoDB database. For more information, see the DynamoDBSettings 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; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)

    The database endpoint identifier.

#endpoint_typeString

The type of endpoint.

Possible values:

  • source
  • target

Returns:

  • (String)

    The type of endpoint.

#engine_nameString

The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

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.

#extra_connection_attributesString

Additional connection attributes used to connect to the endpoint.

Returns:

  • (String)

    Additional connection attributes used to connect to the endpoint.

#kms_key_idString

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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)

    The KMS key identifier that will be used to encrypt the connection parameters.

#mongo_db_settingsTypes::MongoDbSettings

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

Returns:

#portInteger

The port value used to access the endpoint.

Returns:

  • (Integer)

    The port value used to access the endpoint.

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

#ssl_modeString

The SSL mode used to connect to the endpoint.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

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.

#usernameString

The user name used to connect to the endpoint.

Returns:

  • (String)

    The user name used to connect to the endpoint.