NAME

Paws::RDS::StartExportTask - Arguments for method StartExportTask on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method StartExportTask on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method StartExportTask.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartExportTask.

SYNOPSIS

    my $rds = Paws->service('RDS');
    my $ExportTask = $rds->StartExportTask(
      ExportTaskIdentifier => 'MyString',
      IamRoleArn           => 'MyString',
      KmsKeyId             => 'MyString',
      S3BucketName         => 'MyString',
      SourceArn            => 'MyString',
      ExportOnly           => [ 'MyString', ... ],    # OPTIONAL
      S3Prefix             => 'MyString',             # OPTIONAL
    );

    # Results:
    my $ExportOnly             = $ExportTask->ExportOnly;
    my $ExportTaskIdentifier   = $ExportTask->ExportTaskIdentifier;
    my $FailureCause           = $ExportTask->FailureCause;
    my $IamRoleArn             = $ExportTask->IamRoleArn;
    my $KmsKeyId               = $ExportTask->KmsKeyId;
    my $PercentProgress        = $ExportTask->PercentProgress;
    my $S3Bucket               = $ExportTask->S3Bucket;
    my $S3Prefix               = $ExportTask->S3Prefix;
    my $SnapshotTime           = $ExportTask->SnapshotTime;
    my $SourceArn              = $ExportTask->SourceArn;
    my $Status                 = $ExportTask->Status;
    my $TaskEndTime            = $ExportTask->TaskEndTime;
    my $TaskStartTime          = $ExportTask->TaskStartTime;
    my $TotalExtractedDataInGB = $ExportTask->TotalExtractedDataInGB;
    my $WarningMessage         = $ExportTask->WarningMessage;

    # Returns a L<Paws::RDS::ExportTask> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/StartExportTask

ATTRIBUTES

ExportOnly => ArrayRef[Str|Undef]

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.

REQUIRED ExportTaskIdentifier => Str

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.

REQUIRED IamRoleArn => Str

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

REQUIRED KmsKeyId => Str

The ID of the Amazon Web Services KMS customer master key (CMK) 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 Amazon Web Services KMS customer master key (CMK). The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy:

• GrantOperation.Encrypt

• GrantOperation.Decrypt

• GrantOperation.GenerateDataKey

• GrantOperation.GenerateDataKeyWithoutPlaintext

• GrantOperation.ReEncryptFrom

• GrantOperation.ReEncryptTo

• GrantOperation.CreateGrant

• GrantOperation.DescribeKey

• GrantOperation.RetireGrant

REQUIRED S3BucketName => Str

The name of the Amazon S3 bucket to export the snapshot to.

S3Prefix => Str

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

REQUIRED SourceArn => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method StartExportTask in Paws::RDS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues