Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
This command doesn't apply to RDS Custom.
Synopsis
- data StartExportTask = StartExportTask' {
- exportOnly :: Maybe [Text]
- s3Prefix :: Maybe Text
- exportTaskIdentifier :: Text
- sourceArn :: Text
- s3BucketName :: Text
- iamRoleArn :: Text
- kmsKeyId :: Text
- newStartExportTask :: Text -> Text -> Text -> Text -> Text -> StartExportTask
- startExportTask_exportOnly :: Lens' StartExportTask (Maybe [Text])
- startExportTask_s3Prefix :: Lens' StartExportTask (Maybe Text)
- startExportTask_exportTaskIdentifier :: Lens' StartExportTask Text
- startExportTask_sourceArn :: Lens' StartExportTask Text
- startExportTask_s3BucketName :: Lens' StartExportTask Text
- startExportTask_iamRoleArn :: Lens' StartExportTask Text
- startExportTask_kmsKeyId :: Lens' StartExportTask Text
- data ExportTask = ExportTask' {
- exportOnly :: Maybe [Text]
- exportTaskIdentifier :: Maybe Text
- failureCause :: Maybe Text
- iamRoleArn :: Maybe Text
- kmsKeyId :: Maybe Text
- percentProgress :: Maybe Int
- s3Bucket :: Maybe Text
- s3Prefix :: Maybe Text
- snapshotTime :: Maybe ISO8601
- sourceArn :: Maybe Text
- sourceType :: Maybe ExportSourceType
- status :: Maybe Text
- taskEndTime :: Maybe ISO8601
- taskStartTime :: Maybe ISO8601
- totalExtractedDataInGB :: Maybe Int
- warningMessage :: Maybe Text
- newExportTask :: ExportTask
- exportTask_exportOnly :: Lens' ExportTask (Maybe [Text])
- exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text)
- exportTask_failureCause :: Lens' ExportTask (Maybe Text)
- exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text)
- exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text)
- exportTask_percentProgress :: Lens' ExportTask (Maybe Int)
- exportTask_s3Bucket :: Lens' ExportTask (Maybe Text)
- exportTask_s3Prefix :: Lens' ExportTask (Maybe Text)
- exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime)
- exportTask_sourceArn :: Lens' ExportTask (Maybe Text)
- exportTask_sourceType :: Lens' ExportTask (Maybe ExportSourceType)
- exportTask_status :: Lens' ExportTask (Maybe Text)
- exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime)
- exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime)
- exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int)
- exportTask_warningMessage :: Lens' ExportTask (Maybe Text)
Creating a Request
data StartExportTask Source #
See: newStartExportTask
smart constructor.
StartExportTask' | |
|
Instances
Create a value of StartExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartExportTask
, startExportTask_exportOnly
- The data to be exported from the snapshot. If this parameter is not
provided, all the snapshot data is exported. 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.
StartExportTask
, startExportTask_s3Prefix
- The Amazon S3 bucket prefix to use as the file name and path of the
exported snapshot.
StartExportTask
, startExportTask_exportTaskIdentifier
- A unique identifier for the snapshot export task. This ID isn't an
identifier for the Amazon S3 bucket where the snapshot is to be exported
to.
StartExportTask
, startExportTask_sourceArn
- The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
$sel:s3BucketName:StartExportTask'
, startExportTask_s3BucketName
- The name of the Amazon S3 bucket to export the snapshot to.
StartExportTask
, startExportTask_iamRoleArn
- The name of the IAM role to use for writing to the Amazon S3 bucket when
exporting a snapshot.
StartExportTask
, startExportTask_kmsKeyId
- The ID of the Amazon Web Services KMS key to use to encrypt the snapshot
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
Request Lenses
startExportTask_exportOnly :: Lens' StartExportTask (Maybe [Text]) Source #
The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. 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.
startExportTask_s3Prefix :: Lens' StartExportTask (Maybe Text) Source #
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
startExportTask_exportTaskIdentifier :: Lens' StartExportTask Text Source #
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.
startExportTask_sourceArn :: Lens' StartExportTask Text Source #
The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
startExportTask_s3BucketName :: Lens' StartExportTask Text Source #
The name of the Amazon S3 bucket to export the snapshot to.
startExportTask_iamRoleArn :: Lens' StartExportTask Text Source #
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.
startExportTask_kmsKeyId :: Lens' StartExportTask Text Source #
The ID of the Amazon Web Services KMS key to use to encrypt the snapshot 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
Destructuring the Response
data ExportTask Source #
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks
action.
See: newExportTask
smart constructor.
ExportTask' | |
|
Instances
newExportTask :: ExportTask Source #
Create a value of ExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportOnly:ExportTask'
, exportTask_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.
$sel:exportTaskIdentifier:ExportTask'
, exportTask_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.
$sel:failureCause:ExportTask'
, exportTask_failureCause
- The reason the export failed, if it failed.
$sel:iamRoleArn:ExportTask'
, exportTask_iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when
exporting a snapshot.
$sel:kmsKeyId:ExportTask'
, exportTask_kmsKeyId
- The key identifier of the Amazon Web Services KMS key that is used to
encrypt the snapshot 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 snapshot export must have encryption and decryption
permissions to use this KMS key.
$sel:percentProgress:ExportTask'
, exportTask_percentProgress
- The progress of the snapshot export task as a percentage.
$sel:s3Bucket:ExportTask'
, exportTask_s3Bucket
- The Amazon S3 bucket that the snapshot is exported to.
$sel:s3Prefix:ExportTask'
, exportTask_s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the
exported snapshot.
$sel:snapshotTime:ExportTask'
, exportTask_snapshotTime
- The time that the snapshot was created.
$sel:sourceArn:ExportTask'
, exportTask_sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
$sel:sourceType:ExportTask'
, exportTask_sourceType
- The type of source for the export.
$sel:status:ExportTask'
, exportTask_status
- The progress status of the export task.
$sel:taskEndTime:ExportTask'
, exportTask_taskEndTime
- The time that the snapshot export task completed.
$sel:taskStartTime:ExportTask'
, exportTask_taskStartTime
- The time that the snapshot export task started.
$sel:totalExtractedDataInGB:ExportTask'
, exportTask_totalExtractedDataInGB
- The total amount of data exported, in gigabytes.
$sel:warningMessage:ExportTask'
, exportTask_warningMessage
- A warning about the snapshot export task.
Response Lenses
exportTask_exportOnly :: Lens' ExportTask (Maybe [Text]) Source #
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.
exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text) Source #
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.
exportTask_failureCause :: Lens' ExportTask (Maybe Text) Source #
The reason the export failed, if it failed.
exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text) Source #
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text) Source #
The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.
exportTask_percentProgress :: Lens' ExportTask (Maybe Int) Source #
The progress of the snapshot export task as a percentage.
exportTask_s3Bucket :: Lens' ExportTask (Maybe Text) Source #
The Amazon S3 bucket that the snapshot is exported to.
exportTask_s3Prefix :: Lens' ExportTask (Maybe Text) Source #
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime) Source #
The time that the snapshot was created.
exportTask_sourceArn :: Lens' ExportTask (Maybe Text) Source #
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
exportTask_sourceType :: Lens' ExportTask (Maybe ExportSourceType) Source #
The type of source for the export.
exportTask_status :: Lens' ExportTask (Maybe Text) Source #
The progress status of the export task.
exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime) Source #
The time that the snapshot export task completed.
exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime) Source #
The time that the snapshot export task started.
exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int) Source #
The total amount of data exported, in gigabytes.
exportTask_warningMessage :: Lens' ExportTask (Maybe Text) Source #
A warning about the snapshot export task.