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

Amazonka.RDS.Types.ExportTask

Description

Synopsis

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)

Documentation

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.

Constructors

ExportTask'

Fields

exportOnly :: Maybe [Text]
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.
exportTaskIdentifier :: Maybe Text
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.
failureCause :: Maybe Text
The reason the export failed, if it failed.
iamRoleArn :: Maybe Text
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
kmsKeyId :: Maybe Text
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.
percentProgress :: Maybe Int
The progress of the snapshot export task as a percentage.
s3Bucket :: Maybe Text
The Amazon S3 bucket that the snapshot is exported to.
s3Prefix :: Maybe Text
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
snapshotTime :: Maybe ISO8601
The time that the snapshot was created.
sourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
sourceType :: Maybe ExportSourceType
The type of source for the export.
status :: Maybe Text
The progress status of the export task.
taskEndTime :: Maybe ISO8601
The time that the snapshot export task completed.
taskStartTime :: Maybe ISO8601
The time that the snapshot export task started.
totalExtractedDataInGB :: Maybe Int
The total amount of data exported, in gigabytes.
warningMessage :: Maybe Text
A warning about the snapshot export task.

Instances

Instances details

FromXML ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Methods parseXML :: [Node] -> Either String ExportTask #
Generic ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Associated Types type Rep ExportTask :: Type -> Type # Methods from :: ExportTask -> Rep ExportTask x # to :: Rep ExportTask x -> ExportTask #
Read ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Methods readsPrec :: Int -> ReadS ExportTask # readList :: ReadS [ExportTask] # readPrec :: ReadPrec ExportTask # readListPrec :: ReadPrec [ExportTask] #
Show ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Methods showsPrec :: Int -> ExportTask -> ShowS # show :: ExportTask -> String # showList :: [ExportTask] -> ShowS #
NFData ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Methods rnf :: ExportTask -> () #
Eq ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Methods (==) :: ExportTask -> ExportTask -> Bool # (/=) :: ExportTask -> ExportTask -> Bool #
Hashable ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask Methods hashWithSalt :: Int -> ExportTask -> Int # hash :: ExportTask -> Int #
type Rep ExportTask Source #
Instance details Defined in Amazonka.RDS.Types.ExportTask type Rep ExportTask = D1 ('MetaData "ExportTask" "Amazonka.RDS.Types.ExportTask" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ExportTask'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "exportOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "exportTaskIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "failureCause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "snapshotTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportSourceType)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "taskEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "taskStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "totalExtractedDataInGB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "warningMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

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.

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.