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