Interface Endpoint.Builder

    • Method Detail

      • endpointIdentifier

        Endpoint.Builder endpointIdentifier​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • engineName

        Endpoint.Builder engineName​(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".

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • engineDisplayName

        Endpoint.Builder engineDisplayName​(String engineDisplayName)

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

        Parameters:
        engineDisplayName - The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • username

        Endpoint.Builder username​(String username)

        The user name used to connect to the endpoint.

        Parameters:
        username - The user name used to connect to the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • serverName

        Endpoint.Builder serverName​(String serverName)

        The name of the server at the endpoint.

        Parameters:
        serverName - The name of the server at the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • port

        Endpoint.Builder port​(Integer port)

        The port value used to access the endpoint.

        Parameters:
        port - The port value used to access the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • databaseName

        Endpoint.Builder databaseName​(String databaseName)

        The name of the database at the endpoint.

        Parameters:
        databaseName - The name of the database at the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • extraConnectionAttributes

        Endpoint.Builder extraConnectionAttributes​(String extraConnectionAttributes)

        Additional connection attributes used to connect to the endpoint.

        Parameters:
        extraConnectionAttributes - Additional connection attributes used to connect to the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        Endpoint.Builder status​(String status)

        The status of the endpoint.

        Parameters:
        status - The status of the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • kmsKeyId

        Endpoint.Builder kmsKeyId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • endpointArn

        Endpoint.Builder endpointArn​(String endpointArn)

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

        Parameters:
        endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • certificateArn

        Endpoint.Builder certificateArn​(String certificateArn)

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

        Parameters:
        certificateArn - The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sslMode

        Endpoint.Builder sslMode​(String sslMode)

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

        Parameters:
        sslMode - The SSL mode used to connect to the endpoint. The default value is none.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DmsSslModeValue, DmsSslModeValue
      • sslMode

        Endpoint.Builder sslMode​(DmsSslModeValue sslMode)

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

        Parameters:
        sslMode - The SSL mode used to connect to the endpoint. The default value is none.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DmsSslModeValue, DmsSslModeValue
      • serviceAccessRoleArn

        Endpoint.Builder serviceAccessRoleArn​(String serviceAccessRoleArn)

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

        Parameters:
        serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • externalTableDefinition

        Endpoint.Builder externalTableDefinition​(String externalTableDefinition)

        The external table definition.

        Parameters:
        externalTableDefinition - The external table definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • externalId

        Endpoint.Builder externalId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • dynamoDbSettings

        Endpoint.Builder dynamoDbSettings​(DynamoDbSettings dynamoDbSettings)

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

        Parameters:
        dynamoDbSettings - The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • s3Settings

        Endpoint.Builder s3Settings​(S3Settings s3Settings)

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

        Parameters:
        s3Settings - The settings for the S3 target endpoint. For more information, see the S3Settings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dmsTransferSettings

        Endpoint.Builder dmsTransferSettings​(DmsTransferSettings dmsTransferSettings)

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

        Parameters:
        dmsTransferSettings - The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • mongoDbSettings

        Endpoint.Builder mongoDbSettings​(MongoDbSettings mongoDbSettings)

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

        Parameters:
        mongoDbSettings - The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • kinesisSettings

        Endpoint.Builder kinesisSettings​(KinesisSettings kinesisSettings)

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

        Parameters:
        kinesisSettings - The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • kafkaSettings

        Endpoint.Builder kafkaSettings​(KafkaSettings kafkaSettings)

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

        Parameters:
        kafkaSettings - The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • elasticsearchSettings

        Endpoint.Builder elasticsearchSettings​(ElasticsearchSettings elasticsearchSettings)

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

        Parameters:
        elasticsearchSettings - The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • neptuneSettings

        Endpoint.Builder neptuneSettings​(NeptuneSettings neptuneSettings)

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

        Parameters:
        neptuneSettings - The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • redshiftSettings

        Endpoint.Builder redshiftSettings​(RedshiftSettings redshiftSettings)

        Settings for the Amazon Redshift endpoint.

        Parameters:
        redshiftSettings - Settings for the Amazon Redshift endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • postgreSQLSettings

        Endpoint.Builder postgreSQLSettings​(PostgreSQLSettings postgreSQLSettings)

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

        Parameters:
        postgreSQLSettings - The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • mySQLSettings

        Endpoint.Builder mySQLSettings​(MySQLSettings mySQLSettings)

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

        Parameters:
        mySQLSettings - The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • oracleSettings

        Endpoint.Builder oracleSettings​(OracleSettings oracleSettings)

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

        Parameters:
        oracleSettings - The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sybaseSettings

        Endpoint.Builder sybaseSettings​(SybaseSettings sybaseSettings)

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

        Parameters:
        sybaseSettings - The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • microsoftSQLServerSettings

        Endpoint.Builder microsoftSQLServerSettings​(MicrosoftSQLServerSettings microsoftSQLServerSettings)

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

        Parameters:
        microsoftSQLServerSettings - The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • ibmDb2Settings

        Endpoint.Builder ibmDb2Settings​(IBMDb2Settings ibmDb2Settings)

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

        Parameters:
        ibmDb2Settings - The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • docDbSettings

        Endpoint.Builder docDbSettings​(DocDbSettings docDbSettings)
        Sets the value of the DocDbSettings property for this object.
        Parameters:
        docDbSettings - The new value for the DocDbSettings property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • redisSettings

        Endpoint.Builder redisSettings​(RedisSettings redisSettings)

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

        Parameters:
        redisSettings - The settings for the Redis target endpoint. For more information, see the RedisSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • gcpMySQLSettings

        Endpoint.Builder gcpMySQLSettings​(GcpMySQLSettings gcpMySQLSettings)

        Settings in JSON format for the source GCP MySQL endpoint.

        Parameters:
        gcpMySQLSettings - Settings in JSON format for the source GCP MySQL endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • timestreamSettings

        Endpoint.Builder timestreamSettings​(TimestreamSettings timestreamSettings)

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

        Parameters:
        timestreamSettings - The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.