« blib/lib/Paws/DMS/PendingMaintenanceAction.pm
↑ Summary
blib/lib/Paws/DMS/RebootReplicationInstance.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DMS::PostgreSQLSettings; | ||
| 3 | use Moose; | ||
| 4 | has AfterConnectScript => (is => 'ro', isa => 'Str'); | ||
| 5 | has CaptureDdls => (is => 'ro', isa => 'Bool'); | ||
| 6 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 7 | has DdlArtifactsSchema => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExecuteTimeout => (is => 'ro', isa => 'Int'); | ||
| 9 | has FailTasksOnLobTruncation => (is => 'ro', isa => 'Bool'); | ||
| 10 | has MaxFileSize => (is => 'ro', isa => 'Int'); | ||
| 11 | has Password => (is => 'ro', isa => 'Str'); | ||
| 12 | has Port => (is => 'ro', isa => 'Int'); | ||
| 13 | has SecretsManagerAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 14 | has SecretsManagerSecretId => (is => 'ro', isa => 'Str'); | ||
| 15 | has ServerName => (is => 'ro', isa => 'Str'); | ||
| 16 | has SlotName => (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::PostgreSQLSettings | ||
| 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::PostgreSQLSettings object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { AfterConnectScript => $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::PostgreSQLSettings object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->AfterConnectScript | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Provides information that defines a PostgreSQL endpoint. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AfterConnectScript => Str | ||
| 55 | |||
| 56 | For use with change data capture (CDC) only, this attribute has AWS DMS | ||
| 57 | bypass foreign keys and user triggers to reduce the time it takes to | ||
| 58 | bulk load data. | ||
| 59 | |||
| 60 | Example: C<afterConnectScript=SET session_replication_role='replica'> | ||
| 61 | |||
| 62 | |||
| 63 | =head2 CaptureDdls => Bool | ||
| 64 | |||
| 65 | To capture DDL events, AWS DMS creates various artifacts in the | ||
| 66 | PostgreSQL database when the task starts. You can later remove these | ||
| 67 | artifacts. | ||
| 68 | |||
| 69 | If this value is set to C<N>, you don't have to create tables or | ||
| 70 | triggers on the source database. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 DatabaseName => Str | ||
| 74 | |||
| 75 | Database name for the endpoint. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 DdlArtifactsSchema => Str | ||
| 79 | |||
| 80 | The schema in which the operational DDL database artifacts are created. | ||
| 81 | |||
| 82 | Example: C<ddlArtifactsSchema=xyzddlschema;> | ||
| 83 | |||
| 84 | |||
| 85 | =head2 ExecuteTimeout => Int | ||
| 86 | |||
| 87 | Sets the client statement timeout for the PostgreSQL instance, in | ||
| 88 | seconds. The default value is 60 seconds. | ||
| 89 | |||
| 90 | Example: C<executeTimeout=100;> | ||
| 91 | |||
| 92 | |||
| 93 | =head2 FailTasksOnLobTruncation => Bool | ||
| 94 | |||
| 95 | When set to C<true>, this value causes a task to fail if the actual | ||
| 96 | size of a LOB column is greater than the specified C<LobMaxSize>. | ||
| 97 | |||
| 98 | If task is set to Limited LOB mode and this option is set to true, the | ||
| 99 | task fails instead of truncating the LOB data. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 MaxFileSize => Int | ||
| 103 | |||
| 104 | Specifies the maximum size (in KB) of any .csv file used to transfer | ||
| 105 | data to PostgreSQL. | ||
| 106 | |||
| 107 | Example: C<maxFileSize=512> | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Password => Str | ||
| 111 | |||
| 112 | Endpoint connection password. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 Port => Int | ||
| 116 | |||
| 117 | Endpoint TCP port. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 SecretsManagerAccessRoleArn => Str | ||
| 121 | |||
| 122 | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS | ||
| 123 | DMS as the trusted entity and grants the required permissions to access | ||
| 124 | the value in C<SecretsManagerSecret>. C<SecretsManagerSecret> has the | ||
| 125 | value of the AWS Secrets Manager secret that allows access to the | ||
| 126 | PostgreSQL endpoint. | ||
| 127 | |||
| 128 | You can specify one of two sets of values for these permissions. You | ||
| 129 | can specify the values for this setting and C<SecretsManagerSecretId>. | ||
| 130 | Or you can specify clear-text values for C<UserName>, C<Password>, | ||
| 131 | C<ServerName>, and C<Port>. You can't specify both. For more | ||
| 132 | information on creating this C<SecretsManagerSecret> and the | ||
| 133 | C<SecretsManagerAccessRoleArn> and C<SecretsManagerSecretId> required | ||
| 134 | to access it, see Using secrets to access AWS Database Migration | ||
| 135 | Service resources | ||
| 136 | (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) | ||
| 137 | in the I<AWS Database Migration Service User Guide>. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 SecretsManagerSecretId => Str | ||
| 141 | |||
| 142 | The full ARN, partial ARN, or friendly name of the | ||
| 143 | C<SecretsManagerSecret> that contains the PostgreSQL endpoint | ||
| 144 | connection details. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 ServerName => Str | ||
| 148 | |||
| 149 | Fully qualified domain name of the endpoint. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 SlotName => Str | ||
| 153 | |||
| 154 | Sets the name of a previously created logical replication slot for a | ||
| 155 | CDC load of the PostgreSQL source instance. | ||
| 156 | |||
| 157 | When used with the AWS DMS API C<CdcStartPosition> request parameter, | ||
| 158 | this attribute also enables using native CDC start points. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 Username => Str | ||
| 162 | |||
| 163 | Endpoint connection user name. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head1 SEE ALSO | ||
| 168 | |||
| 169 | This class forms part of L<Paws>, describing an object used in L<Paws::DMS> | ||
| 170 | |||
| 171 | =head1 BUGS and CONTRIBUTIONS | ||
| 172 | |||
| 173 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 174 | |||
| 175 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 176 | |||
| 177 | =cut | ||
| 178 |