| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DMS::MicrosoftSQLServerSettings; | ||
| 3 | use Moose; | ||
| 4 | has BcpPacketSize => (is => 'ro', isa => 'Int'); | ||
| 5 | has ControlTablesFileGroup => (is => 'ro', isa => 'Str'); | ||
| 6 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 7 | has Password => (is => 'ro', isa => 'Str'); | ||
| 8 | has Port => (is => 'ro', isa => 'Int'); | ||
| 9 | has QuerySingleAlwaysOnNode => (is => 'ro', isa => 'Bool'); | ||
| 10 | has ReadBackupOnly => (is => 'ro', isa => 'Bool'); | ||
| 11 | has SafeguardPolicy => (is => 'ro', isa => 'Str'); | ||
| 12 | has SecretsManagerAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has SecretsManagerSecretId => (is => 'ro', isa => 'Str'); | ||
| 14 | has ServerName => (is => 'ro', isa => 'Str'); | ||
| 15 | has UseBcpFullLoad => (is => 'ro', isa => 'Bool'); | ||
| 16 | has Username => (is => 'ro', isa => 'Str'); | ||
| 17 | has UseThirdPartyBackupDevice => (is => 'ro', isa => 'Bool'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::DMS::MicrosoftSQLServerSettings | ||
| 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::MicrosoftSQLServerSettings object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { BcpPacketSize => $value, ..., UseThirdPartyBackupDevice => $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::MicrosoftSQLServerSettings object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->BcpPacketSize | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Provides information that defines a Microsoft SQL Server endpoint. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 BcpPacketSize => Int | ||
| 55 | |||
| 56 | The maximum size of the packets (in bytes) used to transfer data using | ||
| 57 | BCP. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ControlTablesFileGroup => Str | ||
| 61 | |||
| 62 | Specifies a file group for the AWS DMS internal tables. When the | ||
| 63 | replication task starts, all the internal AWS DMS control tables | ||
| 64 | (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for | ||
| 65 | the specified file group. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 DatabaseName => Str | ||
| 69 | |||
| 70 | Database name for the endpoint. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Password => Str | ||
| 74 | |||
| 75 | Endpoint connection password. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Port => Int | ||
| 79 | |||
| 80 | Endpoint TCP port. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 QuerySingleAlwaysOnNode => Bool | ||
| 84 | |||
| 85 | Cleans and recreates table metadata information on the replication | ||
| 86 | instance when a mismatch occurs. An example is a situation where | ||
| 87 | running an alter DDL statement on a table might result in different | ||
| 88 | information about the table cached in the replication instance. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ReadBackupOnly => Bool | ||
| 92 | |||
| 93 | When this attribute is set to C<Y>, AWS DMS only reads changes from | ||
| 94 | transaction log backups and doesn't read from the active transaction | ||
| 95 | log file during ongoing replication. Setting this parameter to C<Y> | ||
| 96 | enables you to control active transaction log file growth during full | ||
| 97 | load and ongoing replication tasks. However, it can add some source | ||
| 98 | latency to ongoing replication. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 SafeguardPolicy => Str | ||
| 102 | |||
| 103 | Use this attribute to minimize the need to access the backup log and | ||
| 104 | enable AWS DMS to prevent truncation using one of the following two | ||
| 105 | methods. | ||
| 106 | |||
| 107 | I<Start transactions in the database:> This is the default method. When | ||
| 108 | this method is used, AWS DMS prevents TLOG truncation by mimicking a | ||
| 109 | transaction in the database. As long as such a transaction is open, | ||
| 110 | changes that appear after the transaction started aren't truncated. If | ||
| 111 | you need Microsoft Replication to be enabled in your database, then you | ||
| 112 | must choose this method. | ||
| 113 | |||
| 114 | I<Exclusively use sp_repldone within a single task>: When this method | ||
| 115 | is used, AWS DMS reads the changes and then uses sp_repldone to mark | ||
| 116 | the TLOG transactions as ready for truncation. Although this method | ||
| 117 | doesn't involve any transactional activities, it can only be used when | ||
| 118 | Microsoft Replication isn't running. Also, when using this method, only | ||
| 119 | one AWS DMS task can access the database at any given time. Therefore, | ||
| 120 | if you need to run parallel AWS DMS tasks against the same database, | ||
| 121 | use the default method. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 SecretsManagerAccessRoleArn => Str | ||
| 125 | |||
| 126 | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS | ||
| 127 | DMS as the trusted entity and grants the required permissions to access | ||
| 128 | the value in C<SecretsManagerSecret>. C<SecretsManagerSecret> has the | ||
| 129 | value of the AWS Secrets Manager secret that allows access to the SQL | ||
| 130 | Server endpoint. | ||
| 131 | |||
| 132 | You can specify one of two sets of values for these permissions. You | ||
| 133 | can specify the values for this setting and C<SecretsManagerSecretId>. | ||
| 134 | Or you can specify clear-text values for C<UserName>, C<Password>, | ||
| 135 | C<ServerName>, and C<Port>. You can't specify both. For more | ||
| 136 | information on creating this C<SecretsManagerSecret> and the | ||
| 137 | C<SecretsManagerAccessRoleArn> and C<SecretsManagerSecretId> required | ||
| 138 | to access it, see Using secrets to access AWS Database Migration | ||
| 139 | Service resources | ||
| 140 | (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) | ||
| 141 | in the I<AWS Database Migration Service User Guide>. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 SecretsManagerSecretId => Str | ||
| 145 | |||
| 146 | The full ARN, partial ARN, or friendly name of the | ||
| 147 | C<SecretsManagerSecret> that contains the SQL Server endpoint | ||
| 148 | connection details. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 ServerName => Str | ||
| 152 | |||
| 153 | Fully qualified domain name of the endpoint. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 UseBcpFullLoad => Bool | ||
| 157 | |||
| 158 | Use this to attribute to transfer data for full-load operations using | ||
| 159 | BCP. When the target table contains an identity column that does not | ||
| 160 | exist in the source table, you must disable the use BCP for loading | ||
| 161 | table option. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 Username => Str | ||
| 165 | |||
| 166 | Endpoint connection user name. | ||
| 167 | |||
| 168 | |||
| 169 | =head2 UseThirdPartyBackupDevice => Bool | ||
| 170 | |||
| 171 | When this attribute is set to C<Y>, DMS processes third-party | ||
| 172 | transaction log backups if they are created in native format. | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head1 SEE ALSO | ||
| 177 | |||
| 178 | This class forms part of L<Paws>, describing an object used in L<Paws::DMS> | ||
| 179 | |||
| 180 | =head1 BUGS and CONTRIBUTIONS | ||
| 181 | |||
| 182 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 183 | |||
| 184 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 185 | |||
| 186 | =cut | ||
| 187 |