You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DatabaseMigrationService::Types::RedshiftSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RedshiftSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  accept_any_date: false,
  after_connect_script: "String",
  bucket_folder: "String",
  bucket_name: "String",
  connection_timeout: 1,
  database_name: "String",
  date_format: "String",
  empty_as_null: false,
  encryption_mode: "sse-s3", # accepts sse-s3, sse-kms
  file_transfer_upload_streams: 1,
  load_timeout: 1,
  max_file_size: 1,
  password: "SecretString",
  port: 1,
  remove_quotes: false,
  replace_invalid_chars: "String",
  replace_chars: "String",
  server_name: "String",
  service_access_role_arn: "String",
  server_side_encryption_kms_key_id: "String",
  time_format: "String",
  trim_blanks: false,
  truncate_columns: false,
  username: "String",
  write_buffer_size: 1,
}

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#accept_any_dateBoolean

A 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.

Returns:

  • (Boolean)

    A 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.

#after_connect_scriptString

Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.

Returns:

  • (String)

    Code to run after connecting.

#bucket_folderString

The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.

Returns:

  • (String)

    The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.

#bucket_nameString

The name of the S3 bucket you want to use

Returns:

  • (String)

    The name of the S3 bucket you want to use.

#connection_timeoutInteger

A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

Returns:

  • (Integer)

    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

#database_nameString

The name of the Amazon Redshift data warehouse (service) that you are working with.

Returns:

  • (String)

    The name of the Amazon Redshift data warehouse (service) that you are working with.

#date_formatString

The 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.

Returns:

  • (String)

    The date format that you are using.

#empty_as_nullBoolean

A 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.

Returns:

  • (Boolean)

    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.

#encryption_modeString

The 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. 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"

Possible values:

  • sse-s3
  • sse-kms

Returns:

  • (String)

    The type of server-side encryption that you want to use for your data.

#file_transfer_upload_streamsInteger

The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.

Returns:

  • (Integer)

    The number of threads used to upload a single file.

#load_timeoutInteger

The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

Returns:

  • (Integer)

    The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

#max_file_sizeInteger

The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).

Returns:

  • (Integer)

    The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift.

#passwordString

The password for the user named in the username property.

Returns:

  • (String)

    The password for the user named in the username property.

#portInteger

The port number for Amazon Redshift. The default value is 5439.

Returns:

  • (Integer)

    The port number for Amazon Redshift.

#remove_quotesBoolean

A 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.

Returns:

  • (Boolean)

    A value that specifies to remove surrounding quotation marks from strings in the incoming data.

#replace_charsString

A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".

Returns:

  • (String)

    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead.

#replace_invalid_charsString

A list of characters that you want to replace. Use with ReplaceChars.

Returns:

  • (String)

    A list of characters that you want to replace.

#server_nameString

The name of the Amazon Redshift cluster you are using.

Returns:

  • (String)

    The name of the Amazon Redshift cluster you are using.

#server_side_encryption_kms_key_idString

The 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.

Returns:

  • (String)

    The AWS KMS key ID.

#service_access_role_arnString

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.

#time_formatString

The 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.

Returns:

  • (String)

    The time format that you want to use.

#trim_blanksBoolean

A 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.

Returns:

  • (Boolean)

    A value that specifies to remove the trailing white space characters from a VARCHAR string.

#truncate_columnsBoolean

A 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.

Returns:

  • (Boolean)

    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.

#usernameString

An Amazon Redshift user name for a registered user.

Returns:

  • (String)

    An Amazon Redshift user name for a registered user.

#write_buffer_sizeInteger

The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance.

Returns:

  • (Integer)

    The size of the write buffer to use in rows.