File Coverage

blib/lib/Paws/DMS/MongoDbSettings.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::MongoDbSettings;
2 1     1   468 use Moose;
  1         3  
  1         6  
3             has AuthMechanism => (is => 'ro', isa => 'Str');
4             has AuthSource => (is => 'ro', isa => 'Str');
5             has AuthType => (is => 'ro', isa => 'Str');
6             has DatabaseName => (is => 'ro', isa => 'Str');
7             has DocsToInvestigate => (is => 'ro', isa => 'Str');
8             has ExtractDocId => (is => 'ro', isa => 'Str');
9             has NestingLevel => (is => 'ro', isa => 'Str');
10             has Password => (is => 'ro', isa => 'Str');
11             has Port => (is => 'ro', isa => 'Int');
12             has ServerName => (is => 'ro', isa => 'Str');
13             has Username => (is => 'ro', isa => 'Str');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::DMS::MongoDbSettings
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::DMS::MongoDbSettings object:
32              
33             $service_obj->Method(Att1 => { AuthMechanism => $value, ..., Username => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::MongoDbSettings object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->AuthMechanism
41              
42             =head1 DESCRIPTION
43              
44             This class has no description
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 AuthMechanism => Str
50              
51             The authentication mechanism you use to access the MongoDB source
52             endpoint.
53              
54             Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
55              
56             DEFAULT E<ndash> For MongoDB version 2.x, use MONGODB_CR. For MongoDB
57             version 3.x, use SCRAM_SHA_1. This attribute is not used when
58             authType=No.
59              
60              
61             =head2 AuthSource => Str
62              
63             The MongoDB database name. This attribute is not used when
64             C<authType=NO>.
65              
66             The default is admin.
67              
68              
69             =head2 AuthType => Str
70              
71             The authentication type you use to access the MongoDB source endpoint.
72              
73             Valid values: NO, PASSWORD
74              
75             When NO is selected, user name and password parameters are not used and
76             can be empty.
77              
78              
79             =head2 DatabaseName => Str
80              
81             The database name on the MongoDB source endpoint.
82              
83              
84             =head2 DocsToInvestigate => Str
85              
86             Indicates the number of documents to preview to determine the document
87             organization. Use this attribute when C<NestingLevel> is set to ONE.
88              
89             Must be a positive value greater than 0. Default value is 1000.
90              
91              
92             =head2 ExtractDocId => Str
93              
94             Specifies the document ID. Use this attribute when C<NestingLevel> is
95             set to NONE.
96              
97             Default value is false.
98              
99              
100             =head2 NestingLevel => Str
101              
102             Specifies either document or table mode.
103              
104             Valid values: NONE, ONE
105              
106             Default value is NONE. Specify NONE to use document mode. Specify ONE
107             to use table mode.
108              
109              
110             =head2 Password => Str
111              
112             The password for the user account you use to access the MongoDB source
113             endpoint.
114              
115              
116             =head2 Port => Int
117              
118             The port value for the MongoDB source endpoint.
119              
120              
121             =head2 ServerName => Str
122              
123             The name of the server on the MongoDB source endpoint.
124              
125              
126             =head2 Username => Str
127              
128             The user name you use to access the MongoDB source endpoint.
129              
130              
131              
132             =head1 SEE ALSO
133              
134             This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
135              
136             =head1 BUGS and CONTRIBUTIONS
137              
138             The source code is located here: https://github.com/pplu/aws-sdk-perl
139              
140             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
141              
142             =cut
143