Package software.amazon.awssdk.services.rds.model

Interface ExportTask.Builder

    • Method Detail

      • exportTaskIdentifier

        ExportTask.Builder exportTaskIdentifier​(String exportTaskIdentifier)

        A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

        Parameters:
        exportTaskIdentifier - A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceArn

        ExportTask.Builder sourceArn​(String sourceArn)

        The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

        Parameters:
        sourceArn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exportOnly

        ExportTask.Builder exportOnly​(Collection<String> exportOnly)

        The data exported from the snapshot or cluster.

        Valid Values:

        • database - Export all the data from a specified database.

        • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

        • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        Parameters:
        exportOnly - The data exported from the snapshot or cluster.

        Valid Values:

        • database - Export all the data from a specified database.

        • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

        • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exportOnly

        ExportTask.Builder exportOnly​(String... exportOnly)

        The data exported from the snapshot or cluster.

        Valid Values:

        • database - Export all the data from a specified database.

        • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

        • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        Parameters:
        exportOnly - The data exported from the snapshot or cluster.

        Valid Values:

        • database - Export all the data from a specified database.

        • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

        • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotTime

        ExportTask.Builder snapshotTime​(Instant snapshotTime)

        The time when the snapshot was created.

        Parameters:
        snapshotTime - The time when the snapshot was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • taskStartTime

        ExportTask.Builder taskStartTime​(Instant taskStartTime)

        The time when the snapshot or cluster export task started.

        Parameters:
        taskStartTime - The time when the snapshot or cluster export task started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • taskEndTime

        ExportTask.Builder taskEndTime​(Instant taskEndTime)

        The time when the snapshot or cluster export task ended.

        Parameters:
        taskEndTime - The time when the snapshot or cluster export task ended.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • s3Bucket

        ExportTask.Builder s3Bucket​(String s3Bucket)

        The Amazon S3 bucket where the snapshot or cluster is exported to.

        Parameters:
        s3Bucket - The Amazon S3 bucket where the snapshot or cluster is exported to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • s3Prefix

        ExportTask.Builder s3Prefix​(String s3Prefix)

        The Amazon S3 bucket prefix that is the file name and path of the exported data.

        Parameters:
        s3Prefix - The Amazon S3 bucket prefix that is the file name and path of the exported data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamRoleArn

        ExportTask.Builder iamRoleArn​(String iamRoleArn)

        The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

        Parameters:
        iamRoleArn - The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        ExportTask.Builder kmsKeyId​(String kmsKeyId)

        The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

        Parameters:
        kmsKeyId - The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ExportTask.Builder status​(String status)

        The progress status of the export task. The status can be one of the following:

        • CANCELED

        • CANCELING

        • COMPLETE

        • FAILED

        • IN_PROGRESS

        • STARTING

        Parameters:
        status - The progress status of the export task. The status can be one of the following:

        • CANCELED

        • CANCELING

        • COMPLETE

        • FAILED

        • IN_PROGRESS

        • STARTING

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • percentProgress

        ExportTask.Builder percentProgress​(Integer percentProgress)

        The progress of the snapshot or cluster export task as a percentage.

        Parameters:
        percentProgress - The progress of the snapshot or cluster export task as a percentage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • totalExtractedDataInGB

        ExportTask.Builder totalExtractedDataInGB​(Integer totalExtractedDataInGB)

        The total amount of data exported, in gigabytes.

        Parameters:
        totalExtractedDataInGB - The total amount of data exported, in gigabytes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureCause

        ExportTask.Builder failureCause​(String failureCause)

        The reason the export failed, if it failed.

        Parameters:
        failureCause - The reason the export failed, if it failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • warningMessage

        ExportTask.Builder warningMessage​(String warningMessage)

        A warning about the snapshot or cluster export task.

        Parameters:
        warningMessage - A warning about the snapshot or cluster export task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceType

        ExportTask.Builder sourceType​(String sourceType)

        The type of source for the export.

        Parameters:
        sourceType - The type of source for the export.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExportSourceType, ExportSourceType