File Coverage

blib/lib/Paws/DMS/S3Settings.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::DMS::S3Settings;
2 1     1   420 use Moose;
  1         4  
  1         7  
3             has BucketFolder => (is => 'ro', isa => 'Str');
4             has BucketName => (is => 'ro', isa => 'Str');
5             has CompressionType => (is => 'ro', isa => 'Str');
6             has CsvDelimiter => (is => 'ro', isa => 'Str');
7             has CsvRowDelimiter => (is => 'ro', isa => 'Str');
8             has ExternalTableDefinition => (is => 'ro', isa => 'Str');
9             has ServiceAccessRoleArn => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::DMS::S3Settings
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::DMS::S3Settings object:
28              
29             $service_obj->Method(Att1 => { BucketFolder => $value, ..., ServiceAccessRoleArn => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::S3Settings object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->BucketFolder
37              
38             =head1 DESCRIPTION
39              
40             This class has no description
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 BucketFolder => Str
46              
47             An optional parameter to set a folder name in the S3 bucket. If
48             provided, tables are created in the path
49             E<lt>bucketFolderE<gt>/E<lt>schema_nameE<gt>/E<lt>table_nameE<gt>/. If
50             this parameter is not specified, then the path used is
51             E<lt>schema_nameE<gt>/E<lt>table_nameE<gt>/.
52              
53              
54             =head2 BucketName => Str
55              
56             The name of the S3 bucket.
57              
58              
59             =head2 CompressionType => Str
60              
61             An optional parameter to use GZIP to compress the target files. Set to
62             GZIP to compress the target files. Set to NONE (the default) or do not
63             use to leave the files uncompressed.
64              
65              
66             =head2 CsvDelimiter => Str
67              
68             The delimiter used to separate columns in the source files. The default
69             is a comma.
70              
71              
72             =head2 CsvRowDelimiter => Str
73              
74             The delimiter used to separate rows in the source files. The default is
75             a carriage return (\n).
76              
77              
78             =head2 ExternalTableDefinition => Str
79              
80            
81              
82              
83             =head2 ServiceAccessRoleArn => Str
84              
85             The Amazon Resource Name (ARN) used by the service access IAM role.
86              
87              
88              
89             =head1 SEE ALSO
90              
91             This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
92              
93             =head1 BUGS and CONTRIBUTIONS
94              
95             The source code is located here: https://github.com/pplu/aws-sdk-perl
96              
97             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
98              
99             =cut
100