software.amazon.awssdk.services.rds.model

Interface CancelExportTaskResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>, RdsResponse.Builder, SdkBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CancelExportTaskResponse

public static interface CancelExportTaskResponse.Builder
extends RdsResponse.Builder, SdkPojo, CopyableBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>

Method Summary

Modifier and Type	Method and Description
CancelExportTaskResponse.Builder	exportOnly(Collection<String> exportOnly) The data exported from the snapshot.
CancelExportTaskResponse.Builder	exportOnly(String... exportOnly) The data exported from the snapshot.
CancelExportTaskResponse.Builder	exportTaskIdentifier(String exportTaskIdentifier) A unique identifier for the snapshot export task.
CancelExportTaskResponse.Builder	failureCause(String failureCause) The reason the export failed, if it failed.
CancelExportTaskResponse.Builder	iamRoleArn(String iamRoleArn) The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
CancelExportTaskResponse.Builder	kmsKeyId(String kmsKeyId) The key identifier of the Amazon Web Services KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3.
CancelExportTaskResponse.Builder	percentProgress(Integer percentProgress) The progress of the snapshot export task as a percentage.
CancelExportTaskResponse.Builder	s3Bucket(String s3Bucket) The Amazon S3 bucket that the snapshot is exported to.
CancelExportTaskResponse.Builder	s3Prefix(String s3Prefix) The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
CancelExportTaskResponse.Builder	snapshotTime(Instant snapshotTime) The time that the snapshot was created.
CancelExportTaskResponse.Builder	sourceArn(String sourceArn) The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
CancelExportTaskResponse.Builder	status(String status) The progress status of the export task.
CancelExportTaskResponse.Builder	taskEndTime(Instant taskEndTime) The time that the snapshot export task completed.
CancelExportTaskResponse.Builder	taskStartTime(Instant taskStartTime) The time that the snapshot export task started.
CancelExportTaskResponse.Builder	totalExtractedDataInGB(Integer totalExtractedDataInGB) The total amount of data exported, in gigabytes.
CancelExportTaskResponse.Builder	warningMessage(String warningMessage) A warning about the snapshot export task.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

exportTaskIdentifier

CancelExportTaskResponse.Builder exportTaskIdentifier(String exportTaskIdentifier)

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

Parameters:

exportTaskIdentifier - A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

Returns:

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

sourceArn

CancelExportTaskResponse.Builder sourceArn(String sourceArn)

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

Parameters:

sourceArn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Returns:

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

exportOnly

CancelExportTaskResponse.Builder exportOnly(Collection<String> exportOnly)

The data exported from the snapshot. Valid values are the following:

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

• database.table table-name - Export a table of the snapshot. 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. 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. Valid values are the following:

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

• database.table table-name - Export a table of the snapshot. 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. 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

CancelExportTaskResponse.Builder exportOnly(String... exportOnly)

The data exported from the snapshot. Valid values are the following:

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

• database.table table-name - Export a table of the snapshot. 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. 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. Valid values are the following:

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

• database.table table-name - Export a table of the snapshot. 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. 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

CancelExportTaskResponse.Builder snapshotTime(Instant snapshotTime)

The time that the snapshot was created.

Parameters:

snapshotTime - The time that the snapshot was created.

Returns:

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

taskStartTime

CancelExportTaskResponse.Builder taskStartTime(Instant taskStartTime)

The time that the snapshot export task started.

Parameters:

taskStartTime - The time that the snapshot export task started.

Returns:

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

taskEndTime

CancelExportTaskResponse.Builder taskEndTime(Instant taskEndTime)

The time that the snapshot export task completed.

Parameters:

taskEndTime - The time that the snapshot export task completed.

Returns:

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

s3Bucket

CancelExportTaskResponse.Builder s3Bucket(String s3Bucket)

The Amazon S3 bucket that the snapshot is exported to.

Parameters:

s3Bucket - The Amazon S3 bucket that the snapshot is exported to.

Returns:

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

s3Prefix

CancelExportTaskResponse.Builder s3Prefix(String s3Prefix)

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

Parameters:

s3Prefix - The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

Returns:

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

iamRoleArn

CancelExportTaskResponse.Builder iamRoleArn(String iamRoleArn)

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

Parameters:

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

Returns:

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

kmsKeyId

CancelExportTaskResponse.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

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

status

CancelExportTaskResponse.Builder status(String status)

The progress status of the export task.

Parameters:

status - The progress status of the export task.

Returns:

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

percentProgress

CancelExportTaskResponse.Builder percentProgress(Integer percentProgress)

The progress of the snapshot export task as a percentage.

Parameters:

percentProgress - The progress of the snapshot export task as a percentage.

Returns:

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

totalExtractedDataInGB

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

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

CancelExportTaskResponse.Builder warningMessage(String warningMessage)

A warning about the snapshot export task.

Parameters:

warningMessage - A warning about the snapshot export task.

Returns:

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