#[non_exhaustive]pub struct RedshiftSettingsBuilder { /* private fields */ }
Expand description
A builder for RedshiftSettings
.
Implementations§
Source§impl RedshiftSettingsBuilder
impl RedshiftSettingsBuilder
Sourcepub fn accept_any_date(self, input: bool) -> Self
pub fn accept_any_date(self, input: bool) -> Self
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.
Sourcepub fn set_accept_any_date(self, input: Option<bool>) -> Self
pub fn set_accept_any_date(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_accept_any_date(&self) -> &Option<bool>
pub fn get_accept_any_date(&self) -> &Option<bool>
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.
Sourcepub fn after_connect_script(self, input: impl Into<String>) -> Self
pub fn after_connect_script(self, input: impl Into<String>) -> Self
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
Sourcepub fn set_after_connect_script(self, input: Option<String>) -> Self
pub fn set_after_connect_script(self, input: Option<String>) -> Self
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
Sourcepub fn get_after_connect_script(&self) -> &Option<String>
pub fn get_after_connect_script(&self) -> &Option<String>
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
Sourcepub fn bucket_folder(self, input: impl Into<String>) -> Self
pub fn bucket_folder(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_bucket_folder(self, input: Option<String>) -> Self
pub fn set_bucket_folder(self, input: Option<String>) -> Self
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.
Sourcepub fn get_bucket_folder(&self) -> &Option<String>
pub fn get_bucket_folder(&self) -> &Option<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.
Sourcepub fn bucket_name(self, input: impl Into<String>) -> Self
pub fn bucket_name(self, input: impl Into<String>) -> Self
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
Sourcepub fn set_bucket_name(self, input: Option<String>) -> Self
pub fn set_bucket_name(self, input: Option<String>) -> Self
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
Sourcepub fn get_bucket_name(&self) -> &Option<String>
pub fn get_bucket_name(&self) -> &Option<String>
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
Sourcepub fn case_sensitive_names(self, input: bool) -> Self
pub fn case_sensitive_names(self, input: bool) -> Self
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to true
. The default is false
.
Sourcepub fn set_case_sensitive_names(self, input: Option<bool>) -> Self
pub fn set_case_sensitive_names(self, input: Option<bool>) -> Self
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to true
. The default is false
.
Sourcepub fn get_case_sensitive_names(&self) -> &Option<bool>
pub fn get_case_sensitive_names(&self) -> &Option<bool>
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to true
. The default is false
.
Sourcepub fn comp_update(self, input: bool) -> Self
pub fn comp_update(self, input: bool) -> Self
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
.
Sourcepub fn set_comp_update(self, input: Option<bool>) -> Self
pub fn set_comp_update(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_comp_update(&self) -> &Option<bool>
pub fn get_comp_update(&self) -> &Option<bool>
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
.
Sourcepub fn connection_timeout(self, input: i32) -> Self
pub fn connection_timeout(self, input: i32) -> Self
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
Sourcepub fn set_connection_timeout(self, input: Option<i32>) -> Self
pub fn set_connection_timeout(self, input: Option<i32>) -> Self
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
Sourcepub fn get_connection_timeout(&self) -> &Option<i32>
pub fn get_connection_timeout(&self) -> &Option<i32>
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
Sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
The name of the Amazon Redshift data warehouse (service) that you are working with.
Sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
The name of the Amazon Redshift data warehouse (service) that you are working with.
Sourcepub fn get_database_name(&self) -> &Option<String>
pub fn get_database_name(&self) -> &Option<String>
The name of the Amazon Redshift data warehouse (service) that you are working with.
Sourcepub fn date_format(self, input: impl Into<String>) -> Self
pub fn date_format(self, input: impl Into<String>) -> Self
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
.
Sourcepub fn set_date_format(self, input: Option<String>) -> Self
pub fn set_date_format(self, input: Option<String>) -> Self
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
.
Sourcepub fn get_date_format(&self) -> &Option<String>
pub fn get_date_format(&self) -> &Option<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
.
Sourcepub fn empty_as_null(self, input: bool) -> Self
pub fn empty_as_null(self, input: bool) -> Self
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
.
Sourcepub fn set_empty_as_null(self, input: Option<bool>) -> Self
pub fn set_empty_as_null(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_empty_as_null(&self) -> &Option<bool>
pub fn get_empty_as_null(&self) -> &Option<bool>
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
.
Sourcepub fn encryption_mode(self, input: EncryptionModeValue) -> Self
pub fn encryption_mode(self, input: EncryptionModeValue) -> Self
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
.
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 Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*"
to use the following actions: "s3:PutObject", "s3:ListBucket"
Sourcepub fn set_encryption_mode(self, input: Option<EncryptionModeValue>) -> Self
pub fn set_encryption_mode(self, input: Option<EncryptionModeValue>) -> Self
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
.
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 Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*"
to use the following actions: "s3:PutObject", "s3:ListBucket"
Sourcepub fn get_encryption_mode(&self) -> &Option<EncryptionModeValue>
pub fn get_encryption_mode(&self) -> &Option<EncryptionModeValue>
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
.
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 Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*"
to use the following actions: "s3:PutObject", "s3:ListBucket"
Sourcepub fn explicit_ids(self, input: bool) -> Self
pub fn explicit_ids(self, input: bool) -> Self
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
.
Sourcepub fn set_explicit_ids(self, input: Option<bool>) -> Self
pub fn set_explicit_ids(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_explicit_ids(&self) -> &Option<bool>
pub fn get_explicit_ids(&self) -> &Option<bool>
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
.
Sourcepub fn file_transfer_upload_streams(self, input: i32) -> Self
pub fn file_transfer_upload_streams(self, input: i32) -> Self
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.
Sourcepub fn set_file_transfer_upload_streams(self, input: Option<i32>) -> Self
pub fn set_file_transfer_upload_streams(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_file_transfer_upload_streams(&self) -> &Option<i32>
pub fn get_file_transfer_upload_streams(&self) -> &Option<i32>
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.
Sourcepub fn load_timeout(self, input: i32) -> Self
pub fn load_timeout(self, input: i32) -> Self
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.
Sourcepub fn set_load_timeout(self, input: Option<i32>) -> Self
pub fn set_load_timeout(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_load_timeout(&self) -> &Option<i32>
pub fn get_load_timeout(&self) -> &Option<i32>
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.
Sourcepub fn max_file_size(self, input: i32) -> Self
pub fn max_file_size(self, input: i32) -> Self
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).
Sourcepub fn set_max_file_size(self, input: Option<i32>) -> Self
pub fn set_max_file_size(self, input: Option<i32>) -> Self
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).
Sourcepub fn get_max_file_size(&self) -> &Option<i32>
pub fn get_max_file_size(&self) -> &Option<i32>
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).
Sourcepub fn password(self, input: impl Into<String>) -> Self
pub fn password(self, input: impl Into<String>) -> Self
The password for the user named in the username
property.
Sourcepub fn set_password(self, input: Option<String>) -> Self
pub fn set_password(self, input: Option<String>) -> Self
The password for the user named in the username
property.
Sourcepub fn get_password(&self) -> &Option<String>
pub fn get_password(&self) -> &Option<String>
The password for the user named in the username
property.
Sourcepub fn port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
The port number for Amazon Redshift. The default value is 5439.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port number for Amazon Redshift. The default value is 5439.
Sourcepub fn get_port(&self) -> &Option<i32>
pub fn get_port(&self) -> &Option<i32>
The port number for Amazon Redshift. The default value is 5439.
Sourcepub fn remove_quotes(self, input: bool) -> Self
pub fn remove_quotes(self, input: bool) -> Self
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
.
Sourcepub fn set_remove_quotes(self, input: Option<bool>) -> Self
pub fn set_remove_quotes(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_remove_quotes(&self) -> &Option<bool>
pub fn get_remove_quotes(&self) -> &Option<bool>
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
.
Sourcepub fn replace_invalid_chars(self, input: impl Into<String>) -> Self
pub fn replace_invalid_chars(self, input: impl Into<String>) -> Self
A list of characters that you want to replace. Use with ReplaceChars
.
Sourcepub fn set_replace_invalid_chars(self, input: Option<String>) -> Self
pub fn set_replace_invalid_chars(self, input: Option<String>) -> Self
A list of characters that you want to replace. Use with ReplaceChars
.
Sourcepub fn get_replace_invalid_chars(&self) -> &Option<String>
pub fn get_replace_invalid_chars(&self) -> &Option<String>
A list of characters that you want to replace. Use with ReplaceChars
.
Sourcepub fn replace_chars(self, input: impl Into<String>) -> Self
pub fn replace_chars(self, input: impl Into<String>) -> Self
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars
, substituting the specified characters instead. The default is "?"
.
Sourcepub fn set_replace_chars(self, input: Option<String>) -> Self
pub fn set_replace_chars(self, input: Option<String>) -> Self
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars
, substituting the specified characters instead. The default is "?"
.
Sourcepub fn get_replace_chars(&self) -> &Option<String>
pub fn get_replace_chars(&self) -> &Option<String>
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars
, substituting the specified characters instead. The default is "?"
.
Sourcepub fn server_name(self, input: impl Into<String>) -> Self
pub fn server_name(self, input: impl Into<String>) -> Self
The name of the Amazon Redshift cluster you are using.
Sourcepub fn set_server_name(self, input: Option<String>) -> Self
pub fn set_server_name(self, input: Option<String>) -> Self
The name of the Amazon Redshift cluster you are using.
Sourcepub fn get_server_name(&self) -> &Option<String>
pub fn get_server_name(&self) -> &Option<String>
The name of the Amazon Redshift cluster you are using.
Sourcepub fn service_access_role_arn(self, input: impl Into<String>) -> Self
pub fn service_access_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_service_access_role_arn(self, input: Option<String>) -> Self
pub fn set_service_access_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_service_access_role_arn(&self) -> &Option<String>
pub fn get_service_access_role_arn(&self) -> &Option<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.
Sourcepub fn server_side_encryption_kms_key_id(self, input: impl Into<String>) -> Self
pub fn server_side_encryption_kms_key_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_server_side_encryption_kms_key_id(
self,
input: Option<String>,
) -> Self
pub fn set_server_side_encryption_kms_key_id( self, input: Option<String>, ) -> Self
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.
Sourcepub fn get_server_side_encryption_kms_key_id(&self) -> &Option<String>
pub fn get_server_side_encryption_kms_key_id(&self) -> &Option<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.
Sourcepub fn time_format(self, input: impl Into<String>) -> Self
pub fn time_format(self, input: impl Into<String>) -> Self
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
.
Sourcepub fn set_time_format(self, input: Option<String>) -> Self
pub fn set_time_format(self, input: Option<String>) -> Self
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
.
Sourcepub fn get_time_format(&self) -> &Option<String>
pub fn get_time_format(&self) -> &Option<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
.
Sourcepub fn trim_blanks(self, input: bool) -> Self
pub fn trim_blanks(self, input: bool) -> Self
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
.
Sourcepub fn set_trim_blanks(self, input: Option<bool>) -> Self
pub fn set_trim_blanks(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_trim_blanks(&self) -> &Option<bool>
pub fn get_trim_blanks(&self) -> &Option<bool>
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
.
Sourcepub fn truncate_columns(self, input: bool) -> Self
pub fn truncate_columns(self, input: bool) -> Self
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
.
Sourcepub fn set_truncate_columns(self, input: Option<bool>) -> Self
pub fn set_truncate_columns(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_truncate_columns(&self) -> &Option<bool>
pub fn get_truncate_columns(&self) -> &Option<bool>
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
.
Sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
An Amazon Redshift user name for a registered user.
Sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
An Amazon Redshift user name for a registered user.
Sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
An Amazon Redshift user name for a registered user.
Sourcepub fn write_buffer_size(self, input: i32) -> Self
pub fn write_buffer_size(self, input: i32) -> Self
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).
Sourcepub fn set_write_buffer_size(self, input: Option<i32>) -> Self
pub fn set_write_buffer_size(self, input: Option<i32>) -> Self
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).
Sourcepub fn get_write_buffer_size(&self) -> &Option<i32>
pub fn get_write_buffer_size(&self) -> &Option<i32>
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).
Sourcepub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
pub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
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.
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.
Sourcepub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
pub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
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.
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.
Sourcepub fn get_secrets_manager_access_role_arn(&self) -> &Option<String>
pub fn get_secrets_manager_access_role_arn(&self) -> &Option<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.
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.
Sourcepub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
pub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Amazon Redshift endpoint connection details.
Sourcepub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
pub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Amazon Redshift endpoint connection details.
Sourcepub fn get_secrets_manager_secret_id(&self) -> &Option<String>
pub fn get_secrets_manager_secret_id(&self) -> &Option<String>
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Amazon Redshift endpoint connection details.
Sourcepub fn map_boolean_as_boolean(self, input: bool) -> Self
pub fn map_boolean_as_boolean(self, input: bool) -> Self
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.
Sourcepub fn set_map_boolean_as_boolean(self, input: Option<bool>) -> Self
pub fn set_map_boolean_as_boolean(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_map_boolean_as_boolean(&self) -> &Option<bool>
pub fn get_map_boolean_as_boolean(&self) -> &Option<bool>
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.
Sourcepub fn build(self) -> RedshiftSettings
pub fn build(self) -> RedshiftSettings
Consumes the builder and constructs a RedshiftSettings
.
Trait Implementations§
Source§impl Clone for RedshiftSettingsBuilder
impl Clone for RedshiftSettingsBuilder
Source§fn clone(&self) -> RedshiftSettingsBuilder
fn clone(&self) -> RedshiftSettingsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RedshiftSettingsBuilder
impl Debug for RedshiftSettingsBuilder
Source§impl Default for RedshiftSettingsBuilder
impl Default for RedshiftSettingsBuilder
Source§fn default() -> RedshiftSettingsBuilder
fn default() -> RedshiftSettingsBuilder
Source§impl PartialEq for RedshiftSettingsBuilder
impl PartialEq for RedshiftSettingsBuilder
impl StructuralPartialEq for RedshiftSettingsBuilder
Auto Trait Implementations§
impl Freeze for RedshiftSettingsBuilder
impl RefUnwindSafe for RedshiftSettingsBuilder
impl Send for RedshiftSettingsBuilder
impl Sync for RedshiftSettingsBuilder
impl Unpin for RedshiftSettingsBuilder
impl UnwindSafe for RedshiftSettingsBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);