« blib/lib/Paws/DMS/RebootReplicationInstanceResponse.pm
↑ Summary
blib/lib/Paws/DMS/RefreshSchemas.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DMS::RedshiftSettings; | ||
| 3 | use Moose; | ||
| 4 | has AcceptAnyDate => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AfterConnectScript => (is => 'ro', isa => 'Str'); | ||
| 6 | has BucketFolder => (is => 'ro', isa => 'Str'); | ||
| 7 | has BucketName => (is => 'ro', isa => 'Str'); | ||
| 8 | has CaseSensitiveNames => (is => 'ro', isa => 'Bool'); | ||
| 9 | has CompUpdate => (is => 'ro', isa => 'Bool'); | ||
| 10 | has ConnectionTimeout => (is => 'ro', isa => 'Int'); | ||
| 11 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 12 | has DateFormat => (is => 'ro', isa => 'Str'); | ||
| 13 | has EmptyAsNull => (is => 'ro', isa => 'Bool'); | ||
| 14 | has EncryptionMode => (is => 'ro', isa => 'Str'); | ||
| 15 | has ExplicitIds => (is => 'ro', isa => 'Bool'); | ||
| 16 | has FileTransferUploadStreams => (is => 'ro', isa => 'Int'); | ||
| 17 | has LoadTimeout => (is => 'ro', isa => 'Int'); | ||
| 18 | has MaxFileSize => (is => 'ro', isa => 'Int'); | ||
| 19 | has Password => (is => 'ro', isa => 'Str'); | ||
| 20 | has Port => (is => 'ro', isa => 'Int'); | ||
| 21 | has RemoveQuotes => (is => 'ro', isa => 'Bool'); | ||
| 22 | has ReplaceChars => (is => 'ro', isa => 'Str'); | ||
| 23 | has ReplaceInvalidChars => (is => 'ro', isa => 'Str'); | ||
| 24 | has SecretsManagerAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 25 | has SecretsManagerSecretId => (is => 'ro', isa => 'Str'); | ||
| 26 | has ServerName => (is => 'ro', isa => 'Str'); | ||
| 27 | has ServerSideEncryptionKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 28 | has ServiceAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 29 | has TimeFormat => (is => 'ro', isa => 'Str'); | ||
| 30 | has TrimBlanks => (is => 'ro', isa => 'Bool'); | ||
| 31 | has TruncateColumns => (is => 'ro', isa => 'Bool'); | ||
| 32 | has Username => (is => 'ro', isa => 'Str'); | ||
| 33 | has WriteBufferSize => (is => 'ro', isa => 'Int'); | ||
| 34 | |||
| 35 | 1; | ||
| 36 | |||
| 37 | ### main pod documentation begin ### | ||
| 38 | |||
| 39 | =head1 NAME | ||
| 40 | |||
| 41 | Paws::DMS::RedshiftSettings | ||
| 42 | |||
| 43 | =head1 USAGE | ||
| 44 | |||
| 45 | This class represents one of two things: | ||
| 46 | |||
| 47 | =head3 Arguments in a call to a service | ||
| 48 | |||
| 49 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 50 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 51 | |||
| 52 | As an example, if Att1 is expected to be a Paws::DMS::RedshiftSettings object: | ||
| 53 | |||
| 54 | $service_obj->Method(Att1 => { AcceptAnyDate => $value, ..., WriteBufferSize => $value }); | ||
| 55 | |||
| 56 | =head3 Results returned from an API call | ||
| 57 | |||
| 58 | Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::RedshiftSettings object: | ||
| 59 | |||
| 60 | $result = $service_obj->Method(...); | ||
| 61 | $result->Att1->AcceptAnyDate | ||
| 62 | |||
| 63 | =head1 DESCRIPTION | ||
| 64 | |||
| 65 | Provides information that defines an Amazon Redshift endpoint. | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 AcceptAnyDate => Bool | ||
| 71 | |||
| 72 | A value that indicates to allow any date format, including invalid | ||
| 73 | formats such as 00/00/00 00:00:00, to be loaded without generating an | ||
| 74 | error. You can choose C<true> or C<false> (the default). | ||
| 75 | |||
| 76 | This parameter applies only to TIMESTAMP and DATE columns. Always use | ||
| 77 | ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the | ||
| 78 | data doesn't match the DATEFORMAT specification, Amazon Redshift | ||
| 79 | inserts a NULL value into that field. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 AfterConnectScript => Str | ||
| 83 | |||
| 84 | Code to run after connecting. This parameter should contain the code | ||
| 85 | itself, not the name of a file containing the code. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 BucketFolder => Str | ||
| 89 | |||
| 90 | An S3 folder where the comma-separated-value (.csv) files are stored | ||
| 91 | before being uploaded to the target Redshift cluster. | ||
| 92 | |||
| 93 | For full load mode, AWS DMS converts source records into .csv files and | ||
| 94 | loads them to the I<BucketFolder/TableID> path. AWS DMS uses the | ||
| 95 | Redshift C<COPY> command to upload the .csv files to the target table. | ||
| 96 | The files are deleted once the C<COPY> operation has finished. For more | ||
| 97 | information, see COPY | ||
| 98 | (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the | ||
| 99 | I<Amazon Redshift Database Developer Guide>. | ||
| 100 | |||
| 101 | For change-data-capture (CDC) mode, AWS DMS creates a I<NetChanges> | ||
| 102 | table, and loads the .csv files to this | ||
| 103 | I<BucketFolder/NetChangesTableID> path. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 BucketName => Str | ||
| 107 | |||
| 108 | The name of the intermediate S3 bucket used to store .csv files before | ||
| 109 | uploading data to Redshift. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 CaseSensitiveNames => Bool | ||
| 113 | |||
| 114 | If Amazon Redshift is configured to support case sensitive schema | ||
| 115 | names, set C<CaseSensitiveNames> to C<true>. The default is C<false>. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 CompUpdate => Bool | ||
| 119 | |||
| 120 | If you set C<CompUpdate> to C<true> Amazon Redshift applies automatic | ||
| 121 | compression if the table is empty. This applies even if the table | ||
| 122 | columns already have encodings other than C<RAW>. If you set | ||
| 123 | C<CompUpdate> to C<false>, automatic compression is disabled and | ||
| 124 | existing column encodings aren't changed. The default is C<true>. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 ConnectionTimeout => Int | ||
| 128 | |||
| 129 | A value that sets the amount of time to wait (in milliseconds) before | ||
| 130 | timing out, beginning from when you initially establish a connection. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 DatabaseName => Str | ||
| 134 | |||
| 135 | The name of the Amazon Redshift data warehouse (service) that you are | ||
| 136 | working with. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 DateFormat => Str | ||
| 140 | |||
| 141 | The date format that you are using. Valid values are C<auto> | ||
| 142 | (case-sensitive), your date format string enclosed in quotes, or NULL. | ||
| 143 | If this parameter is left unset (NULL), it defaults to a format of | ||
| 144 | 'YYYY-MM-DD'. Using C<auto> recognizes most strings, even some that | ||
| 145 | aren't supported when you use a date format string. | ||
| 146 | |||
| 147 | If your date and time values use formats different from each other, set | ||
| 148 | this to C<auto>. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 EmptyAsNull => Bool | ||
| 152 | |||
| 153 | A value that specifies whether AWS DMS should migrate empty CHAR and | ||
| 154 | VARCHAR fields as NULL. A value of C<true> sets empty CHAR and VARCHAR | ||
| 155 | fields to null. The default is C<false>. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 EncryptionMode => Str | ||
| 159 | |||
| 160 | The type of server-side encryption that you want to use for your data. | ||
| 161 | This encryption type is part of the endpoint settings or the extra | ||
| 162 | connections attributes for Amazon S3. You can choose either C<SSE_S3> | ||
| 163 | (the default) or C<SSE_KMS>. | ||
| 164 | |||
| 165 | For the C<ModifyEndpoint> operation, you can change the existing value | ||
| 166 | of the C<EncryptionMode> parameter from C<SSE_KMS> to C<SSE_S3>. But | ||
| 167 | you canE<rsquo>t change the existing value from C<SSE_S3> to | ||
| 168 | C<SSE_KMS>. | ||
| 169 | |||
| 170 | To use C<SSE_S3>, create an AWS Identity and Access Management (IAM) | ||
| 171 | role with a policy that allows C<"arn:aws:s3:::*"> to use the following | ||
| 172 | actions: C<"s3:PutObject", "s3:ListBucket"> | ||
| 173 | |||
| 174 | |||
| 175 | =head2 ExplicitIds => Bool | ||
| 176 | |||
| 177 | This setting is only valid for a full-load migration task. Set | ||
| 178 | C<ExplicitIds> to C<true> to have tables with C<IDENTITY> columns | ||
| 179 | override their auto-generated values with explicit values loaded from | ||
| 180 | the source data files used to populate the tables. The default is | ||
| 181 | C<false>. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 FileTransferUploadStreams => Int | ||
| 185 | |||
| 186 | The number of threads used to upload a single file. This parameter | ||
| 187 | accepts a value from 1 through 64. It defaults to 10. | ||
| 188 | |||
| 189 | The number of parallel streams used to upload a single .csv file to an | ||
| 190 | S3 bucket using S3 Multipart Upload. For more information, see | ||
| 191 | Multipart upload overview | ||
| 192 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). | ||
| 193 | |||
| 194 | C<FileTransferUploadStreams> accepts a value from 1 through 64. It | ||
| 195 | defaults to 10. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 LoadTimeout => Int | ||
| 199 | |||
| 200 | The amount of time to wait (in milliseconds) before timing out of | ||
| 201 | operations performed by AWS DMS on a Redshift cluster, such as Redshift | ||
| 202 | COPY, INSERT, DELETE, and UPDATE. | ||
| 203 | |||
| 204 | |||
| 205 | =head2 MaxFileSize => Int | ||
| 206 | |||
| 207 | The maximum size (in KB) of any .csv file used to load data on an S3 | ||
| 208 | bucket and transfer data to Amazon Redshift. It defaults to 1048576KB | ||
| 209 | (1 GB). | ||
| 210 | |||
| 211 | |||
| 212 | =head2 Password => Str | ||
| 213 | |||
| 214 | The password for the user named in the C<username> property. | ||
| 215 | |||
| 216 | |||
| 217 | =head2 Port => Int | ||
| 218 | |||
| 219 | The port number for Amazon Redshift. The default value is 5439. | ||
| 220 | |||
| 221 | |||
| 222 | =head2 RemoveQuotes => Bool | ||
| 223 | |||
| 224 | A value that specifies to remove surrounding quotation marks from | ||
| 225 | strings in the incoming data. All characters within the quotation | ||
| 226 | marks, including delimiters, are retained. Choose C<true> to remove | ||
| 227 | quotation marks. The default is C<false>. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 ReplaceChars => Str | ||
| 231 | |||
| 232 | A value that specifies to replaces the invalid characters specified in | ||
| 233 | C<ReplaceInvalidChars>, substituting the specified characters instead. | ||
| 234 | The default is C<"?">. | ||
| 235 | |||
| 236 | |||
| 237 | =head2 ReplaceInvalidChars => Str | ||
| 238 | |||
| 239 | A list of characters that you want to replace. Use with | ||
| 240 | C<ReplaceChars>. | ||
| 241 | |||
| 242 | |||
| 243 | =head2 SecretsManagerAccessRoleArn => Str | ||
| 244 | |||
| 245 | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS | ||
| 246 | DMS as the trusted entity and grants the required permissions to access | ||
| 247 | the value in C<SecretsManagerSecret>. C<SecretsManagerSecret> has the | ||
| 248 | value of the AWS Secrets Manager secret that allows access to the | ||
| 249 | Amazon Redshift endpoint. | ||
| 250 | |||
| 251 | You can specify one of two sets of values for these permissions. You | ||
| 252 | can specify the values for this setting and C<SecretsManagerSecretId>. | ||
| 253 | Or you can specify clear-text values for C<UserName>, C<Password>, | ||
| 254 | C<ServerName>, and C<Port>. You can't specify both. For more | ||
| 255 | information on creating this C<SecretsManagerSecret> and the | ||
| 256 | C<SecretsManagerAccessRoleArn> and C<SecretsManagerSecretId> required | ||
| 257 | to access it, see Using secrets to access AWS Database Migration | ||
| 258 | Service resources | ||
| 259 | (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) | ||
| 260 | in the I<AWS Database Migration Service User Guide>. | ||
| 261 | |||
| 262 | |||
| 263 | =head2 SecretsManagerSecretId => Str | ||
| 264 | |||
| 265 | The full ARN, partial ARN, or friendly name of the | ||
| 266 | C<SecretsManagerSecret> that contains the Amazon Redshift endpoint | ||
| 267 | connection details. | ||
| 268 | |||
| 269 | |||
| 270 | =head2 ServerName => Str | ||
| 271 | |||
| 272 | The name of the Amazon Redshift cluster you are using. | ||
| 273 | |||
| 274 | |||
| 275 | =head2 ServerSideEncryptionKmsKeyId => Str | ||
| 276 | |||
| 277 | The AWS KMS key ID. If you are using C<SSE_KMS> for the | ||
| 278 | C<EncryptionMode>, provide this key ID. The key that you use needs an | ||
| 279 | attached policy that enables IAM user permissions and allows use of the | ||
| 280 | key. | ||
| 281 | |||
| 282 | |||
| 283 | =head2 ServiceAccessRoleArn => Str | ||
| 284 | |||
| 285 | The Amazon Resource Name (ARN) of the IAM role that has access to the | ||
| 286 | Amazon Redshift service. | ||
| 287 | |||
| 288 | |||
| 289 | =head2 TimeFormat => Str | ||
| 290 | |||
| 291 | The time format that you want to use. Valid values are C<auto> | ||
| 292 | (case-sensitive), C<'timeformat_string'>, C<'epochsecs'>, or | ||
| 293 | C<'epochmillisecs'>. It defaults to 10. Using C<auto> recognizes most | ||
| 294 | strings, even some that aren't supported when you use a time format | ||
| 295 | string. | ||
| 296 | |||
| 297 | If your date and time values use formats different from each other, set | ||
| 298 | this parameter to C<auto>. | ||
| 299 | |||
| 300 | |||
| 301 | =head2 TrimBlanks => Bool | ||
| 302 | |||
| 303 | A value that specifies to remove the trailing white space characters | ||
| 304 | from a VARCHAR string. This parameter applies only to columns with a | ||
| 305 | VARCHAR data type. Choose C<true> to remove unneeded white space. The | ||
| 306 | default is C<false>. | ||
| 307 | |||
| 308 | |||
| 309 | =head2 TruncateColumns => Bool | ||
| 310 | |||
| 311 | A value that specifies to truncate data in columns to the appropriate | ||
| 312 | number of characters, so that the data fits in the column. This | ||
| 313 | parameter applies only to columns with a VARCHAR or CHAR data type, and | ||
| 314 | rows with a size of 4 MB or less. Choose C<true> to truncate data. The | ||
| 315 | default is C<false>. | ||
| 316 | |||
| 317 | |||
| 318 | =head2 Username => Str | ||
| 319 | |||
| 320 | An Amazon Redshift user name for a registered user. | ||
| 321 | |||
| 322 | |||
| 323 | =head2 WriteBufferSize => Int | ||
| 324 | |||
| 325 | The size (in KB) of the in-memory file write buffer used when | ||
| 326 | generating .csv files on the local disk at the DMS replication | ||
| 327 | instance. The default value is 1000 (buffer size is 1000KB). | ||
| 328 | |||
| 329 | |||
| 330 | |||
| 331 | =head1 SEE ALSO | ||
| 332 | |||
| 333 | This class forms part of L<Paws>, describing an object used in L<Paws::DMS> | ||
| 334 | |||
| 335 | =head1 BUGS and CONTRIBUTIONS | ||
| 336 | |||
| 337 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 338 | |||
| 339 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 340 | |||
| 341 | =cut | ||
| 342 |