blib/lib/Paws/RDS/StartExportTask.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::StartExportTask;
3 use Moose;
4 has ExportOnly => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has ExportTaskIdentifier => (is => 'ro', isa => 'Str', required => 1);
6 has IamRoleArn => (is => 'ro', isa => 'Str', required => 1);
7 has KmsKeyId => (is => 'ro', isa => 'Str', required => 1);
8 has S3BucketName => (is => 'ro', isa => 'Str', required => 1);
9 has S3Prefix => (is => 'ro', isa => 'Str');
10 has SourceArn => (is => 'ro', isa => 'Str', required => 1);
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartExportTask');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ExportTask');
16 class_has _result_key => (isa => 'Str', is => 'ro', default => 'StartExportTaskResult');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::RDS::StartExportTask - Arguments for method StartExportTask on L<Paws::RDS>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method StartExportTask on the
28 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
29 as arguments to method StartExportTask.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartExportTask.
32  
33 =head1 SYNOPSIS
34  
35 my $rds = Paws->service('RDS');
36 my $ExportTask = $rds->StartExportTask(
37 ExportTaskIdentifier => 'MyString',
38 IamRoleArn => 'MyString',
39 KmsKeyId => 'MyString',
40 S3BucketName => 'MyString',
41 SourceArn => 'MyString',
42 ExportOnly => [ 'MyString', ... ], # OPTIONAL
43 S3Prefix => 'MyString', # OPTIONAL
44 );
45  
46 # Results:
47 my $ExportOnly = $ExportTask->ExportOnly;
48 my $ExportTaskIdentifier = $ExportTask->ExportTaskIdentifier;
49 my $FailureCause = $ExportTask->FailureCause;
50 my $IamRoleArn = $ExportTask->IamRoleArn;
51 my $KmsKeyId = $ExportTask->KmsKeyId;
52 my $PercentProgress = $ExportTask->PercentProgress;
53 my $S3Bucket = $ExportTask->S3Bucket;
54 my $S3Prefix = $ExportTask->S3Prefix;
55 my $SnapshotTime = $ExportTask->SnapshotTime;
56 my $SourceArn = $ExportTask->SourceArn;
57 my $Status = $ExportTask->Status;
58 my $TaskEndTime = $ExportTask->TaskEndTime;
59 my $TaskStartTime = $ExportTask->TaskStartTime;
60 my $TotalExtractedDataInGB = $ExportTask->TotalExtractedDataInGB;
61 my $WarningMessage = $ExportTask->WarningMessage;
62  
63 # Returns a L<Paws::RDS::ExportTask> object.
64  
65 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.
66 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/StartExportTask>
67  
68 =head1 ATTRIBUTES
69  
70  
71 =head2 ExportOnly => ArrayRef[Str|Undef]
72  
73 The data to be exported from the snapshot. If this parameter is not
74 provided, all the snapshot data is exported. Valid values are the
75 following:
76  
77 =over
78  
79 =item *
80  
81 C<database> - Export all the data from a specified database.
82  
83 =item *
84  
85 C<database.table> I<table-name> - Export a table of the snapshot. This
86 format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora
87 MySQL.
88  
89 =item *
90  
91 C<database.schema> I<schema-name> - Export a database schema of the
92 snapshot. This format is valid only for RDS for PostgreSQL and Aurora
93 PostgreSQL.
94  
95 =item *
96  
97 C<database.schema.table> I<table-name> - Export a table of the database
98 schema. This format is valid only for RDS for PostgreSQL and Aurora
99 PostgreSQL.
100  
101 =back
102  
103  
104  
105  
106 =head2 B<REQUIRED> ExportTaskIdentifier => Str
107  
108 A unique identifier for the snapshot export task. This ID isn't an
109 identifier for the Amazon S3 bucket where the snapshot is to be
110 exported to.
111  
112  
113  
114 =head2 B<REQUIRED> IamRoleArn => Str
115  
116 The name of the IAM role to use for writing to the Amazon S3 bucket
117 when exporting a snapshot.
118  
119  
120  
121 =head2 B<REQUIRED> KmsKeyId => Str
122  
123 The ID of the Amazon Web Services KMS customer master key (CMK) to use
124 to encrypt the snapshot exported to Amazon S3. The Amazon Web Services
125 KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
126 the Amazon Web Services KMS customer master key (CMK). The caller of
127 this operation must be authorized to execute the following operations.
128 These can be set in the Amazon Web Services KMS key policy:
129  
130 =over
131  
132 =item *
133  
134 GrantOperation.Encrypt
135  
136 =item *
137  
138 GrantOperation.Decrypt
139  
140 =item *
141  
142 GrantOperation.GenerateDataKey
143  
144 =item *
145  
146 GrantOperation.GenerateDataKeyWithoutPlaintext
147  
148 =item *
149  
150 GrantOperation.ReEncryptFrom
151  
152 =item *
153  
154 GrantOperation.ReEncryptTo
155  
156 =item *
157  
158 GrantOperation.CreateGrant
159  
160 =item *
161  
162 GrantOperation.DescribeKey
163  
164 =item *
165  
166 GrantOperation.RetireGrant
167  
168 =back
169  
170  
171  
172  
173 =head2 B<REQUIRED> S3BucketName => Str
174  
175 The name of the Amazon S3 bucket to export the snapshot to.
176  
177  
178  
179 =head2 S3Prefix => Str
180  
181 The Amazon S3 bucket prefix to use as the file name and path of the
182 exported snapshot.
183  
184  
185  
186 =head2 B<REQUIRED> SourceArn => Str
187  
188 The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
189  
190  
191  
192  
193 =head1 SEE ALSO
194  
195 This class forms part of L<Paws>, documenting arguments for method StartExportTask in L<Paws::RDS>
196  
197 =head1 BUGS and CONTRIBUTIONS
198  
199 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
200  
201 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
202  
203 =cut
204