![]() |
![]()
| ![]() |
![]()
NAMEPaws::DMS::RedshiftSettings USAGEThis class represents one of two things: Arguments in a call to a service Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object. As an example, if Att1 is expected to be a Paws::DMS::RedshiftSettings object: $service_obj->Method(Att1 => { AcceptAnyDate => $value, ..., WriteBufferSize => $value }); Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::RedshiftSettings object: $result = $service_obj->Method(...); $result->Att1->AcceptAnyDate DESCRIPTIONProvides information that defines an Amazon Redshift endpoint. ATTRIBUTESAcceptAnyDate => BoolA value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose "true" or "false" (the default). This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. AfterConnectScript => StrCode to run after connecting. This parameter should contain the code itself, not the name of a file containing the code. BucketFolder => StrAn S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS DMS uses the Redshift "COPY" command to upload the .csv files to the target table. The files are deleted once the "COPY" operation has finished. For more information, see COPY (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the Amazon Redshift Database Developer Guide. For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path. BucketName => StrThe name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift. CaseSensitiveNames => BoolIf Amazon Redshift is configured to support case sensitive schema names, set "CaseSensitiveNames" to "true". The default is "false". CompUpdate => BoolIf you set "CompUpdate" to "true" Amazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other than "RAW". If you set "CompUpdate" to "false", automatic compression is disabled and existing column encodings aren't changed. The default is "true". ConnectionTimeout => IntA value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection. DatabaseName => StrThe name of the Amazon Redshift data warehouse (service) that you are working with. DateFormat => StrThe date format that you are using. Valid values are "auto" (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using "auto" recognizes most strings, even some that aren't supported when you use a date format string. If your date and time values use formats different from each other, set this to "auto". EmptyAsNull => BoolA value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of "true" sets empty CHAR and VARCHAR fields to null. The default is "false". EncryptionMode => StrThe type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either "SSE_S3" (the default) or "SSE_KMS". For the "ModifyEndpoint" operation, you can change the existing value of the "EncryptionMode" parameter from "SSE_KMS" to "SSE_S3". But you can’t change the existing value from "SSE_S3" to "SSE_KMS". To use "SSE_S3", create an AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" ExplicitIds => BoolThis setting is only valid for a full-load migration task. Set "ExplicitIds" to "true" to have tables with "IDENTITY" columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is "false". FileTransferUploadStreams => IntThe number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10. The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). "FileTransferUploadStreams" accepts a value from 1 through 64. It defaults to 10. LoadTimeout => IntThe amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE. MaxFileSize => IntThe maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB). Password => StrThe password for the user named in the "username" property. Port => IntThe port number for Amazon Redshift. The default value is 5439. RemoveQuotes => BoolA value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose "true" to remove quotation marks. The default is "false". ReplaceChars => StrA value that specifies to replaces the invalid characters specified in "ReplaceInvalidChars", substituting the specified characters instead. The default is "?". ReplaceInvalidChars => StrA list of characters that you want to replace. Use with "ReplaceChars". SecretsManagerAccessRoleArn => StrThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in "SecretsManagerSecret". "SecretsManagerSecret" has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and "SecretsManagerSecretId". Or you can specify clear-text values for "UserName", "Password", "ServerName", and "Port". You can't specify both. For more information on creating this "SecretsManagerSecret" and the "SecretsManagerAccessRoleArn" and "SecretsManagerSecretId" required to access it, see Using secrets to access AWS Database Migration Service resources (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide. SecretsManagerSecretId => StrThe full ARN, partial ARN, or friendly name of the "SecretsManagerSecret" that contains the Amazon Redshift endpoint connection details. ServerName => StrThe name of the Amazon Redshift cluster you are using. ServerSideEncryptionKmsKeyId => StrThe AWS KMS key ID. If you are using "SSE_KMS" for the "EncryptionMode", provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key. ServiceAccessRoleArn => StrThe Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. TimeFormat => StrThe time format that you want to use. Valid values are "auto" (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using "auto" recognizes most strings, even some that aren't supported when you use a time format string. If your date and time values use formats different from each other, set this parameter to "auto". TrimBlanks => BoolA value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose "true" to remove unneeded white space. The default is "false". TruncateColumns => BoolA value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose "true" to truncate data. The default is "false". Username => StrAn Amazon Redshift user name for a registered user. WriteBufferSize => IntThe size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB). SEE ALSOThis class forms part of Paws, describing an object used in Paws::DMS BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|