Interface StartExportTaskRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartExportTaskRequest.Builder,
,StartExportTaskRequest> RdsRequest.Builder
,SdkBuilder<StartExportTaskRequest.Builder,
,StartExportTaskRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartExportTaskRequest
-
Method Summary
Modifier and TypeMethodDescriptionexportOnly
(String... exportOnly) The data to be exported from the snapshot or cluster.exportOnly
(Collection<String> exportOnly) The data to be exported from the snapshot or cluster.exportTaskIdentifier
(String exportTaskIdentifier) A unique identifier for the export task.iamRoleArn
(String iamRoleArn) The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.s3BucketName
(String s3BucketName) The name of the Amazon S3 bucket to export the snapshot or cluster data to.The Amazon S3 bucket prefix to use as the file name and path of the exported data.The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
exportTaskIdentifier
A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.
- Parameters:
exportTaskIdentifier
- A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceArn
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
- Parameters:
sourceArn
- The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3BucketName
The name of the Amazon S3 bucket to export the snapshot or cluster data to.
- Parameters:
s3BucketName
- The name of the Amazon S3 bucket to export the snapshot or cluster data to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRoleArn
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
-
s3:PutObject*
-
s3:GetObject*
-
s3:ListBucket
-
s3:DeleteObject*
-
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
-
arn:aws:s3:::your-s3-bucket
-
arn:aws:s3:::your-s3-bucket/*
- Parameters:
iamRoleArn
- The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
-
s3:PutObject*
-
s3:GetObject*
-
s3:ListBucket
-
s3:DeleteObject*
-
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
-
arn:aws:s3:::your-s3-bucket
-
arn:aws:s3:::your-s3-bucket/*
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
kmsKeyId
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
-
kms:Encrypt
-
kms:Decrypt
-
kms:GenerateDataKey
-
kms:GenerateDataKeyWithoutPlaintext
-
kms:ReEncryptFrom
-
kms:ReEncryptTo
-
kms:CreateGrant
-
kms:DescribeKey
-
kms:RetireGrant
- Parameters:
kmsKeyId
- The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:-
kms:Encrypt
-
kms:Decrypt
-
kms:GenerateDataKey
-
kms:GenerateDataKeyWithoutPlaintext
-
kms:ReEncryptFrom
-
kms:ReEncryptTo
-
kms:CreateGrant
-
kms:DescribeKey
-
kms:RetireGrant
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
s3Prefix
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
- Parameters:
s3Prefix
- The Amazon S3 bucket prefix to use as the file name and path of the exported data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportOnly
The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.
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 to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.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
The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.
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 to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.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.
-
-
overrideConfiguration
StartExportTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartExportTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-