Class Endpoint

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.Endpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Endpoint.Builder,Endpoint>
@Generated("software.amazon.awssdk:codegen") public final class Endpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Endpoint.Builder,Endpoint>

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

  • CreateEndpoint

  • DescribeEndpoint

  • ModifyEndpoint

See Also:

  • Method Details

    • endpointIdentifier

      public final String endpointIdentifier()

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

    • endpointType

      public final ReplicationEndpointTypeValue endpointType()

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

      If the service returns an enum value that is not available in the current SDK version, endpointType will return ReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

      Returns:
      The type of endpoint. Valid values are source and target.
      See Also:

    • endpointTypeAsString

      public final String endpointTypeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, endpointType will return ReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

      Returns:
      The type of endpoint. Valid values are source and target.
      See Also:

    • engineName

      public final String engineName()

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

    • engineDisplayName

      public final String engineDisplayName()

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

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

    • username

      public final String username()

      The user name used to connect to the endpoint.

      Returns:
      The user name used to connect to the endpoint.

    • serverName

      public final String serverName()

      The name of the server at the endpoint.

      Returns:
      The name of the server at the endpoint.

    • port

      public final Integer port()

      The port value used to access the endpoint.

      Returns:
      The port value used to access the endpoint.

    • databaseName

      public final String databaseName()

      The name of the database at the endpoint.

      Returns:
      The name of the database at the endpoint.

    • extraConnectionAttributes

      public final String extraConnectionAttributes()

      Additional connection attributes used to connect to the endpoint.

      Returns:
      Additional connection attributes used to connect to the endpoint.

    • status

      public final String status()

      The status of the endpoint.

      Returns:
      The status of the endpoint.

    • kmsKeyId

      public final String kmsKeyId()

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

    • endpointArn

      public final String endpointArn()

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

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

    • certificateArn

      public final String certificateArn()

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

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

    • sslMode

      public final DmsSslModeValue sslMode()

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

      If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

      Returns:
      The SSL mode used to connect to the endpoint. The default value is none.
      See Also:

    • sslModeAsString

      public final String sslModeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

      Returns:
      The SSL mode used to connect to the endpoint. The default value is none.
      See Also:

    • serviceAccessRoleArn

      public final String serviceAccessRoleArn()

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

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

    • externalTableDefinition

      public final String externalTableDefinition()

      The external table definition.

      Returns:
      The external table definition.

    • externalId

      public final String externalId()

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

    • dynamoDbSettings

      public final DynamoDbSettings dynamoDbSettings()

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

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

    • s3Settings

      public final S3Settings s3Settings()

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

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

    • dmsTransferSettings

      public final DmsTransferSettings dmsTransferSettings()

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

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

    • mongoDbSettings

      public final MongoDbSettings mongoDbSettings()

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

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

    • kinesisSettings

      public final KinesisSettings kinesisSettings()

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

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

    • kafkaSettings

      public final KafkaSettings kafkaSettings()

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

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

    • elasticsearchSettings

      public final ElasticsearchSettings elasticsearchSettings()

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

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

    • neptuneSettings

      public final NeptuneSettings neptuneSettings()

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

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

    • redshiftSettings

      public final RedshiftSettings redshiftSettings()

      Settings for the Amazon Redshift endpoint.

      Returns:
      Settings for the Amazon Redshift endpoint.

    • postgreSQLSettings

      public final PostgreSQLSettings postgreSQLSettings()

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

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

    • mySQLSettings

      public final MySQLSettings mySQLSettings()

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

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

    • oracleSettings

      public final OracleSettings oracleSettings()

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

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

    • sybaseSettings

      public final SybaseSettings sybaseSettings()

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

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

    • microsoftSQLServerSettings

      public final MicrosoftSQLServerSettings microsoftSQLServerSettings()

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

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

    • ibmDb2Settings

      public final IBMDb2Settings ibmDb2Settings()

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

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

    • docDbSettings

      public final DocDbSettings docDbSettings()
      Returns the value of the DocDbSettings property for this object.
      Returns:
      The value of the DocDbSettings property for this object.

    • redisSettings

      public final RedisSettings redisSettings()

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

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

    • gcpMySQLSettings

      public final GcpMySQLSettings gcpMySQLSettings()

      Settings in JSON format for the source GCP MySQL endpoint.

      Returns:
      Settings in JSON format for the source GCP MySQL endpoint.

    • timestreamSettings

      public final TimestreamSettings timestreamSettings()

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

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

    • toBuilder

      public Endpoint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Endpoint.Builder,Endpoint>
      Returns:
      a builder for type T

    • builder

      public static Endpoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Endpoint.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.