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

Inherits:

Struct

Object
Struct
Aws::DatabaseMigrationService::Types::RedshiftSettings

show all

Includes:: Structure

Defined in:: lib/aws-sdk-databasemigrationservice/types.rb

Overview

Provides information that defines an Amazon Redshift endpoint.

Constant Summary collapse

SENSITIVE =

[:password]

Instance Attribute Summary collapse

#accept_any_date ⇒ 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_script ⇒ String

Code to run after connecting.
#bucket_folder ⇒ String

An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
#bucket_name ⇒ String

The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
#case_sensitive_names ⇒ Boolean

If Amazon Redshift is configured to support case sensitive schema names, set ‘CaseSensitiveNames` to `true`.
#comp_update ⇒ Boolean

If you set ‘CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty.
#connection_timeout ⇒ 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_name ⇒ String

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

The date format that you are using.
#empty_as_null ⇒ Boolean

A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
#encryption_mode ⇒ String

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

This setting is only valid for a full-load migration task.
#file_transfer_upload_streams ⇒ Integer

The number of threads used to upload a single file.
#load_timeout ⇒ Integer

The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
#map_boolean_as_boolean ⇒ Boolean

When true, lets Redshift migrate the boolean type as boolean.
#max_file_size ⇒ Integer

The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift.
#password ⇒ String

The password for the user named in the ‘username` property.
#port ⇒ Integer

The port number for Amazon Redshift.
#remove_quotes ⇒ Boolean

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

A value that specifies to replaces the invalid characters specified in ‘ReplaceInvalidChars`, substituting the specified characters instead.
#replace_invalid_chars ⇒ String

A list of characters that you want to replace.
#secrets_manager_access_role_arn ⇒ String

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in ‘SecretsManagerSecret`.
#secrets_manager_secret_id ⇒ String

The full ARN, partial ARN, or friendly name of the ‘SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details.
#server_name ⇒ String

The name of the Amazon Redshift cluster you are using.
#server_side_encryption_kms_key_id ⇒ String

The KMS key ID.
#service_access_role_arn ⇒ String

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

The time format that you want to use.
#trim_blanks ⇒ Boolean

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

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

An Amazon Redshift user name for a registered user.
#write_buffer_size ⇒ Integer

The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance.

Instance Attribute Details

#accept_any_date ⇒ `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. 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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#after_connect_script ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#bucket_folder ⇒ `String`

An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.

For full load mode, DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. 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] in the *Amazon Redshift Database Developer Guide*.

For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.

[1]: docs.aws.amazon.com/redshift/latest/dg/r_COPY.html

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#bucket_name ⇒ `String`

The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#case_sensitive_names ⇒ `Boolean`

If Amazon Redshift is configured to support case sensitive schema names, set ‘CaseSensitiveNames` to `true`. The default is `false`.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#comp_update ⇒ `Boolean`

If 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`.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#connection_timeout ⇒ `Integer`

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#date_format ⇒ `String`

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#empty_as_null ⇒ `Boolean`

A value that specifies whether 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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#encryption_mode ⇒ `String`

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

<note markdown=“1”> 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`.

</note>

To use ‘SSE_S3`, create an Identity and Access Management (IAM) role with a policy that allows `“arn:aws:s3:::*”` to use the following actions: `“s3:PutObject”, “s3:ListBucket”`

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#explicit_ids ⇒ `Boolean`

This 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`.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#file_transfer_upload_streams ⇒ `Integer`

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

‘FileTransferUploadStreams` accepts a value from 1 through 64. It defaults to 10.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html

Returns:

(Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#load_timeout ⇒ `Integer`

The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.

Returns:

(Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#map_boolean_as_boolean ⇒ `Boolean`

When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as ‘varchar(1)`. You must set this setting on both the source and target endpoints for it to take effect.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_file_size ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password ⇒ `String`

The password for the user named in the ‘username` property.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#port ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#remove_quotes ⇒ `Boolean`

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#replace_chars ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#replace_invalid_chars ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_access_role_arn ⇒ `String`

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in ‘SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.

<note markdown=“1”> 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 Database Migration Service resources] in the *Database Migration Service User Guide*.

</note>

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_id ⇒ `String`

The full ARN, partial ARN, or friendly name of the ‘SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_name ⇒ `String`

The name of the Amazon Redshift cluster you are using.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_side_encryption_kms_key_id ⇒ `String`

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

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#service_access_role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the ‘iam:PassRole` action.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#time_format ⇒ `String`

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#trim_blanks ⇒ `Boolean`

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#truncate_columns ⇒ `Boolean`

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#username ⇒ `String`

An Amazon Redshift user name for a registered user.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

#write_buffer_size ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10530

class RedshiftSettings < Struct.new(
  :accept_any_date,
  :after_connect_script,
  :bucket_folder,
  :bucket_name,
  :case_sensitive_names,
  :comp_update,
  :connection_timeout,
  :database_name,
  :date_format,
  :empty_as_null,
  :encryption_mode,
  :explicit_ids,
  :file_transfer_upload_streams,
  :load_timeout,
  :max_file_size,
  :password,
  :port,
  :remove_quotes,
  :replace_invalid_chars,
  :replace_chars,
  :server_name,
  :service_access_role_arn,
  :server_side_encryption_kms_key_id,
  :time_format,
  :trim_blanks,
  :truncate_columns,
  :username,
  :write_buffer_size,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :map_boolean_as_boolean)
  SENSITIVE = [:password]
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#accept_any_date ⇒ Boolean

#after_connect_script ⇒ String

#bucket_folder ⇒ String

#bucket_name ⇒ String

#case_sensitive_names ⇒ Boolean

#comp_update ⇒ Boolean

#connection_timeout ⇒ Integer

#database_name ⇒ String

#date_format ⇒ String

#empty_as_null ⇒ Boolean

#encryption_mode ⇒ String

#explicit_ids ⇒ Boolean

#file_transfer_upload_streams ⇒ Integer

#load_timeout ⇒ Integer

#map_boolean_as_boolean ⇒ Boolean

#max_file_size ⇒ Integer

#password ⇒ String

#port ⇒ Integer

#remove_quotes ⇒ Boolean

#replace_chars ⇒ String

#replace_invalid_chars ⇒ String

#secrets_manager_access_role_arn ⇒ String

#secrets_manager_secret_id ⇒ String

#server_name ⇒ String

#server_side_encryption_kms_key_id ⇒ String

#service_access_role_arn ⇒ String

#time_format ⇒ String

#trim_blanks ⇒ Boolean

#truncate_columns ⇒ Boolean

#username ⇒ String

#write_buffer_size ⇒ Integer

#accept_any_date ⇒ `Boolean`

#after_connect_script ⇒ `String`

#bucket_folder ⇒ `String`

#bucket_name ⇒ `String`

#case_sensitive_names ⇒ `Boolean`

#comp_update ⇒ `Boolean`

#connection_timeout ⇒ `Integer`

#database_name ⇒ `String`

#date_format ⇒ `String`

#empty_as_null ⇒ `Boolean`

#encryption_mode ⇒ `String`

#explicit_ids ⇒ `Boolean`

#file_transfer_upload_streams ⇒ `Integer`

#load_timeout ⇒ `Integer`

#map_boolean_as_boolean ⇒ `Boolean`

#max_file_size ⇒ `Integer`

#password ⇒ `String`

#port ⇒ `Integer`

#remove_quotes ⇒ `Boolean`

#replace_chars ⇒ `String`

#replace_invalid_chars ⇒ `String`

#secrets_manager_access_role_arn ⇒ `String`

#secrets_manager_secret_id ⇒ `String`

#server_name ⇒ `String`

#server_side_encryption_kms_key_id ⇒ `String`

#service_access_role_arn ⇒ `String`

#time_format ⇒ `String`

#trim_blanks ⇒ `Boolean`

#truncate_columns ⇒ `Boolean`

#username ⇒ `String`

#write_buffer_size ⇒ `Integer`