blib/lib/Paws/DMS/DocDbSettings.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::DMS::DocDbSettings;
3 use Moose;
4 has DatabaseName => (is => 'ro', isa => 'Str');
5 has DocsToInvestigate => (is => 'ro', isa => 'Int');
6 has ExtractDocId => (is => 'ro', isa => 'Bool');
7 has KmsKeyId => (is => 'ro', isa => 'Str');
8 has NestingLevel => (is => 'ro', isa => 'Str');
9 has Password => (is => 'ro', isa => 'Str');
10 has Port => (is => 'ro', isa => 'Int');
11 has SecretsManagerAccessRoleArn => (is => 'ro', isa => 'Str');
12 has SecretsManagerSecretId => (is => 'ro', isa => 'Str');
13 has ServerName => (is => 'ro', isa => 'Str');
14 has Username => (is => 'ro', isa => 'Str');
15  
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::DMS::DocDbSettings
23  
24 =head1 USAGE
25  
26 This class represents one of two things:
27  
28 =head3 Arguments in a call to a service
29  
30 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31 Each attribute should be used as a named argument in the calls that expect this type of object.
32  
33 As an example, if Att1 is expected to be a Paws::DMS::DocDbSettings object:
34  
35 $service_obj->Method(Att1 => { DatabaseName => $value, ..., Username => $value });
36  
37 =head3 Results returned from an API call
38  
39 Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::DocDbSettings object:
40  
41 $result = $service_obj->Method(...);
42 $result->Att1->DatabaseName
43  
44 =head1 DESCRIPTION
45  
46 Provides information that defines a DocumentDB endpoint.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 DatabaseName => Str
52  
53 The database name on the DocumentDB source endpoint.
54  
55  
56 =head2 DocsToInvestigate => Int
57  
58 Indicates the number of documents to preview to determine the document
59 organization. Use this setting when C<NestingLevel> is set to C<"one">.
60  
61 Must be a positive value greater than C<0>. Default value is C<1000>.
62  
63  
64 =head2 ExtractDocId => Bool
65  
66 Specifies the document ID. Use this setting when C<NestingLevel> is set
67 to C<"none">.
68  
69 Default value is C<"false">.
70  
71  
72 =head2 KmsKeyId => Str
73  
74 The AWS KMS key identifier that is used to encrypt the content on the
75 replication instance. If you don't specify a value for the C<KmsKeyId>
76 parameter, then AWS DMS uses your default encryption key. AWS KMS
77 creates the default encryption key for your AWS account. Your AWS
78 account has a different default encryption key for each AWS Region.
79  
80  
81 =head2 NestingLevel => Str
82  
83 Specifies either document or table mode.
84  
85 Default value is C<"none">. Specify C<"none"> to use document mode.
86 Specify C<"one"> to use table mode.
87  
88  
89 =head2 Password => Str
90  
91 The password for the user account you use to access the DocumentDB
92 source endpoint.
93  
94  
95 =head2 Port => Int
96  
97 The port value for the DocumentDB source endpoint.
98  
99  
100 =head2 SecretsManagerAccessRoleArn => Str
101  
102 The full Amazon Resource Name (ARN) of the IAM role that specifies AWS
103 DMS as the trusted entity and grants the required permissions to access
104 the value in C<SecretsManagerSecret>. C<SecretsManagerSecret> has the
105 value of the AWS Secrets Manager secret that allows access to the
106 DocumentDB endpoint.
107  
108 You can specify one of two sets of values for these permissions. You
109 can specify the values for this setting and C<SecretsManagerSecretId>.
110 Or you can specify clear-text values for C<UserName>, C<Password>,
111 C<ServerName>, and C<Port>. You can't specify both. For more
112 information on creating this C<SecretsManagerSecret> and the
113 C<SecretsManagerAccessRoleArn> and C<SecretsManagerSecretId> required
114 to access it, see Using secrets to access AWS Database Migration
115 Service resources
116 (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
117 in the I<AWS Database Migration Service User Guide>.
118  
119  
120 =head2 SecretsManagerSecretId => Str
121  
122 The full ARN, partial ARN, or friendly name of the
123 C<SecretsManagerSecret> that contains the DocumentDB endpoint
124 connection details.
125  
126  
127 =head2 ServerName => Str
128  
129 The name of the server on the DocumentDB source endpoint.
130  
131  
132 =head2 Username => Str
133  
134 The user name you use to access the DocumentDB source endpoint.
135  
136  
137  
138 =head1 SEE ALSO
139  
140 This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
141  
142 =head1 BUGS and CONTRIBUTIONS
143  
144 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
145  
146 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
147  
148 =cut
149