Class: AWSCDK::DMS::CfnEndpoint::RedshiftSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_endpoint.rb

Overview

Provides information that defines an Amazon Redshift endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(accept_any_date: nil, after_connect_script: nil, bucket_folder: nil, bucket_name: nil, case_sensitive_names: nil, comp_update: nil, connection_timeout: nil, date_format: nil, empty_as_null: nil, encryption_mode: nil, explicit_ids: nil, file_transfer_upload_streams: nil, load_timeout: nil, map_boolean_as_boolean: nil, max_file_size: nil, remove_quotes: nil, replace_chars: nil, replace_invalid_chars: nil, secrets_manager_access_role_arn: nil, secrets_manager_secret_id: nil, server_side_encryption_kms_key_id: nil, service_access_role_arn: nil, time_format: nil, trim_blanks: nil, truncate_columns: nil, write_buffer_size: nil) ⇒ RedshiftSettingsProperty

Returns a new instance of RedshiftSettingsProperty.

Parameters:

  • accept_any_date (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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, nil) (defaults to: nil) —

    Code to run after connecting.

  • bucket_folder (String, nil) (defaults to: nil) —

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

  • bucket_name (String, nil) (defaults to: nil) —

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

  • case_sensitive_names (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true .

  • comp_update (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.

  • connection_timeout (Numeric, nil) (defaults to: nil) —

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

  • date_format (String, nil) (defaults to: nil) —

    The date format that you are using.

  • empty_as_null (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • encryption_mode (String, nil) (defaults to: nil) —

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

  • explicit_ids (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    This setting is only valid for a full-load migration task.

  • file_transfer_upload_streams (Numeric, nil) (defaults to: nil) —

    The number of threads used to upload a single file.

  • load_timeout (Numeric, nil) (defaults to: nil) —

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

  • map_boolean_as_boolean (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When true, lets Redshift migrate the boolean type as boolean.

  • max_file_size (Numeric, nil) (defaults to: nil) —

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

  • remove_quotes (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • replace_chars (String, nil) (defaults to: nil) —

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

  • replace_invalid_chars (String, nil) (defaults to: nil) —

    A list of characters that you want to replace.

  • secrets_manager_access_role_arn (String, nil) (defaults to: nil) —

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

  • secrets_manager_secret_id (String, nil) (defaults to: nil) —

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

  • server_side_encryption_kms_key_id (String, nil) (defaults to: nil) —

    The AWS key ID.

  • service_access_role_arn (String, nil) (defaults to: nil) —

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

  • time_format (String, nil) (defaults to: nil) —

    The time format that you want to use.

  • trim_blanks (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • truncate_columns (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • write_buffer_size (Numeric, nil) (defaults to: nil) —

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



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
 
# File 'dms/cfn_endpoint.rb', line 3288

def initialize(accept_any_date: nil, after_connect_script: nil, bucket_folder: nil, bucket_name: nil, case_sensitive_names: nil, comp_update: nil, connection_timeout: nil, date_format: nil, empty_as_null: nil, encryption_mode: nil, explicit_ids: nil, file_transfer_upload_streams: nil, load_timeout: nil, map_boolean_as_boolean: nil, max_file_size: nil, remove_quotes: nil, replace_chars: nil, replace_invalid_chars: nil, secrets_manager_access_role_arn: nil, secrets_manager_secret_id: nil, server_side_encryption_kms_key_id: nil, service_access_role_arn: nil, time_format: nil, trim_blanks: nil, truncate_columns: nil, write_buffer_size: nil)
  @accept_any_date = accept_any_date
  Jsii::Type.check_type(@accept_any_date, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "acceptAnyDate") unless @accept_any_date.nil?
  @after_connect_script = after_connect_script
  Jsii::Type.check_type(@after_connect_script, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "afterConnectScript") unless @after_connect_script.nil?
  @bucket_folder = bucket_folder
  Jsii::Type.check_type(@bucket_folder, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketFolder") unless @bucket_folder.nil?
  @bucket_name = bucket_name
  Jsii::Type.check_type(@bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName") unless @bucket_name.nil?
  @case_sensitive_names = case_sensitive_names
  Jsii::Type.check_type(@case_sensitive_names, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "caseSensitiveNames") unless @case_sensitive_names.nil?
  @comp_update = comp_update
  Jsii::Type.check_type(@comp_update, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "compUpdate") unless @comp_update.nil?
  @connection_timeout = connection_timeout
  Jsii::Type.check_type(@connection_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "connectionTimeout") unless @connection_timeout.nil?
  @date_format = date_format
  Jsii::Type.check_type(@date_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dateFormat") unless @date_format.nil?
  @empty_as_null = empty_as_null
  Jsii::Type.check_type(@empty_as_null, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "emptyAsNull") unless @empty_as_null.nil?
  @encryption_mode = encryption_mode
  Jsii::Type.check_type(@encryption_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionMode") unless @encryption_mode.nil?
  @explicit_ids = explicit_ids
  Jsii::Type.check_type(@explicit_ids, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "explicitIds") unless @explicit_ids.nil?
  @file_transfer_upload_streams = file_transfer_upload_streams
  Jsii::Type.check_type(@file_transfer_upload_streams, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fileTransferUploadStreams") unless @file_transfer_upload_streams.nil?
  @load_timeout = load_timeout
  Jsii::Type.check_type(@load_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "loadTimeout") unless @load_timeout.nil?
  @map_boolean_as_boolean = map_boolean_as_boolean
  Jsii::Type.check_type(@map_boolean_as_boolean, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "mapBooleanAsBoolean") unless @map_boolean_as_boolean.nil?
  @max_file_size = max_file_size
  Jsii::Type.check_type(@max_file_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxFileSize") unless @max_file_size.nil?
  @remove_quotes = remove_quotes
  Jsii::Type.check_type(@remove_quotes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "removeQuotes") unless @remove_quotes.nil?
  @replace_chars = replace_chars
  Jsii::Type.check_type(@replace_chars, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replaceChars") unless @replace_chars.nil?
  @replace_invalid_chars = replace_invalid_chars
  Jsii::Type.check_type(@replace_invalid_chars, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replaceInvalidChars") unless @replace_invalid_chars.nil?
  @secrets_manager_access_role_arn = secrets_manager_access_role_arn
  Jsii::Type.check_type(@secrets_manager_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerAccessRoleArn") unless @secrets_manager_access_role_arn.nil?
  @secrets_manager_secret_id = secrets_manager_secret_id
  Jsii::Type.check_type(@secrets_manager_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerSecretId") unless @secrets_manager_secret_id.nil?
  @server_side_encryption_kms_key_id = server_side_encryption_kms_key_id
  Jsii::Type.check_type(@server_side_encryption_kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverSideEncryptionKmsKeyId") unless @server_side_encryption_kms_key_id.nil?
  @service_access_role_arn = service_access_role_arn
  Jsii::Type.check_type(@service_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceAccessRoleArn") unless @service_access_role_arn.nil?
  @time_format = time_format
  Jsii::Type.check_type(@time_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeFormat") unless @time_format.nil?
  @trim_blanks = trim_blanks
  Jsii::Type.check_type(@trim_blanks, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "trimBlanks") unless @trim_blanks.nil?
  @truncate_columns = truncate_columns
  Jsii::Type.check_type(@truncate_columns, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "truncateColumns") unless @truncate_columns.nil?
  @write_buffer_size = write_buffer_size
  Jsii::Type.check_type(@write_buffer_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "writeBufferSize") unless @write_buffer_size.nil?
end

Instance Attribute Details

#accept_any_date ⇒ Boolean, ... (readonly)

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:

See Also:



3351
3352
3353
 
# File 'dms/cfn_endpoint.rb', line 3351

def accept_any_date
  @accept_any_date
end

#after_connect_script ⇒ String? (readonly)

Code to run after connecting.

This parameter should contain the code itself, not the name of a file containing the code.

Returns:

  • (String, nil)

See Also:



3358
3359
3360
 
# File 'dms/cfn_endpoint.rb', line 3358

def after_connect_script
  @after_connect_script
end

#bucket_folder ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



3367
3368
3369
 
# File 'dms/cfn_endpoint.rb', line 3367

def bucket_folder
  @bucket_folder
end

#bucket_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



3372
3373
3374
 
# File 'dms/cfn_endpoint.rb', line 3372

def bucket_name
  @bucket_name
end

#case_sensitive_names ⇒ Boolean, ... (readonly)

If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true .

The default is false .

Returns:

See Also:



3379
3380
3381
 
# File 'dms/cfn_endpoint.rb', line 3379

def case_sensitive_names
  @case_sensitive_names
end

#comp_update ⇒ Boolean, ... (readonly)

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:

See Also:



3386
3387
3388
 
# File 'dms/cfn_endpoint.rb', line 3386

def comp_update
  @comp_update
end

#connection_timeout ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



3391
3392
3393
 
# File 'dms/cfn_endpoint.rb', line 3391

def connection_timeout
  @connection_timeout
end

#date_format ⇒ String? (readonly)

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, nil)

See Also:



3400
3401
3402
 
# File 'dms/cfn_endpoint.rb', line 3400

def date_format
  @date_format
end

#empty_as_null ⇒ Boolean, ... (readonly)

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:

See Also:



3407
3408
3409
 
# File 'dms/cfn_endpoint.rb', line 3407

def empty_as_null
  @empty_as_null
end

#encryption_mode ⇒ String? (readonly)

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 AWS 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, nil)

See Also:



3418
3419
3420
 
# File 'dms/cfn_endpoint.rb', line 3418

def encryption_mode
  @encryption_mode
end

#explicit_ids ⇒ Boolean, ... (readonly)

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:

See Also:



3425
3426
3427
 
# File 'dms/cfn_endpoint.rb', line 3425

def explicit_ids
  @explicit_ids
end

#file_transfer_upload_streams ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



3436
3437
3438
 
# File 'dms/cfn_endpoint.rb', line 3436

def file_transfer_upload_streams
  @file_transfer_upload_streams
end

#load_timeout ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



3441
3442
3443
 
# File 'dms/cfn_endpoint.rb', line 3441

def load_timeout
  @load_timeout
end

#map_boolean_as_boolean ⇒ Boolean, ... (readonly)

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:

See Also:



3448
3449
3450
 
# File 'dms/cfn_endpoint.rb', line 3448

def map_boolean_as_boolean
  @map_boolean_as_boolean
end

#max_file_size ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



3453
3454
3455
 
# File 'dms/cfn_endpoint.rb', line 3453

def max_file_size
  @max_file_size
end

#remove_quotes ⇒ Boolean, ... (readonly)

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:

See Also:



3460
3461
3462
 
# File 'dms/cfn_endpoint.rb', line 3460

def remove_quotes
  @remove_quotes
end

#replace_chars ⇒ String? (readonly)

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

The default is "?" .

Returns:

  • (String, nil)

See Also:



3467
3468
3469
 
# File 'dms/cfn_endpoint.rb', line 3467

def replace_chars
  @replace_chars
end

#replace_invalid_chars ⇒ String? (readonly)

A list of characters that you want to replace.

Use with ReplaceChars .

Returns:

  • (String, nil)

See Also:



3474
3475
3476
 
# File 'dms/cfn_endpoint.rb', line 3474

def replace_invalid_chars
  @replace_invalid_chars
end

#secrets_manager_access_role_arn ⇒ String? (readonly)

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

The role must allow the iam:PassRole action. 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 , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



3485
3486
3487
 
# File 'dms/cfn_endpoint.rb', line 3485

def secrets_manager_access_role_arn
  @secrets_manager_access_role_arn
end

#secrets_manager_secret_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



3490
3491
3492
 
# File 'dms/cfn_endpoint.rb', line 3490

def secrets_manager_secret_id
  @secrets_manager_secret_id
end

#server_side_encryption_kms_key_id ⇒ String? (readonly)

The AWS 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, nil)

See Also:



3497
3498
3499
 
# File 'dms/cfn_endpoint.rb', line 3497

def server_side_encryption_kms_key_id
  @server_side_encryption_kms_key_id
end

#service_access_role_arn ⇒ String? (readonly)

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, nil)

See Also:



3504
3505
3506
 
# File 'dms/cfn_endpoint.rb', line 3504

def service_access_role_arn
  @service_access_role_arn
end

#time_format ⇒ String? (readonly)

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, nil)

See Also:



3513
3514
3515
 
# File 'dms/cfn_endpoint.rb', line 3513

def time_format
  @time_format
end

#trim_blanks ⇒ Boolean, ... (readonly)

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:

See Also:



3520
3521
3522
 
# File 'dms/cfn_endpoint.rb', line 3520

def trim_blanks
  @trim_blanks
end

#truncate_columns ⇒ Boolean, ... (readonly)

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:

See Also:



3527
3528
3529
 
# File 'dms/cfn_endpoint.rb', line 3527

def truncate_columns
  @truncate_columns
end

#write_buffer_size ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



3532
3533
3534
 
# File 'dms/cfn_endpoint.rb', line 3532

def write_buffer_size
  @write_buffer_size
end

Class Method Details

.jsii_properties ⇒ Object 



3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
 
# File 'dms/cfn_endpoint.rb', line 3534

def self.jsii_properties
  {
    :accept_any_date => "acceptAnyDate",
    :after_connect_script => "afterConnectScript",
    :bucket_folder => "bucketFolder",
    :bucket_name => "bucketName",
    :case_sensitive_names => "caseSensitiveNames",
    :comp_update => "compUpdate",
    :connection_timeout => "connectionTimeout",
    :date_format => "dateFormat",
    :empty_as_null => "emptyAsNull",
    :encryption_mode => "encryptionMode",
    :explicit_ids => "explicitIds",
    :file_transfer_upload_streams => "fileTransferUploadStreams",
    :load_timeout => "loadTimeout",
    :map_boolean_as_boolean => "mapBooleanAsBoolean",
    :max_file_size => "maxFileSize",
    :remove_quotes => "removeQuotes",
    :replace_chars => "replaceChars",
    :replace_invalid_chars => "replaceInvalidChars",
    :secrets_manager_access_role_arn => "secretsManagerAccessRoleArn",
    :secrets_manager_secret_id => "secretsManagerSecretId",
    :server_side_encryption_kms_key_id => "serverSideEncryptionKmsKeyId",
    :service_access_role_arn => "serviceAccessRoleArn",
    :time_format => "timeFormat",
    :trim_blanks => "trimBlanks",
    :truncate_columns => "truncateColumns",
    :write_buffer_size => "writeBufferSize",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
 
# File 'dms/cfn_endpoint.rb', line 3565

def to_jsii
  result = {}
  result.merge!({
    "acceptAnyDate" => @accept_any_date,
    "afterConnectScript" => @after_connect_script,
    "bucketFolder" => @bucket_folder,
    "bucketName" => @bucket_name,
    "caseSensitiveNames" => @case_sensitive_names,
    "compUpdate" => @comp_update,
    "connectionTimeout" => @connection_timeout,
    "dateFormat" => @date_format,
    "emptyAsNull" => @empty_as_null,
    "encryptionMode" => @encryption_mode,
    "explicitIds" => @explicit_ids,
    "fileTransferUploadStreams" => @file_transfer_upload_streams,
    "loadTimeout" => @load_timeout,
    "mapBooleanAsBoolean" => @map_boolean_as_boolean,
    "maxFileSize" => @max_file_size,
    "removeQuotes" => @remove_quotes,
    "replaceChars" => @replace_chars,
    "replaceInvalidChars" => @replace_invalid_chars,
    "secretsManagerAccessRoleArn" => @secrets_manager_access_role_arn,
    "secretsManagerSecretId" => @secrets_manager_secret_id,
    "serverSideEncryptionKmsKeyId" => @server_side_encryption_kms_key_id,
    "serviceAccessRoleArn" => @service_access_role_arn,
    "timeFormat" => @time_format,
    "trimBlanks" => @trim_blanks,
    "truncateColumns" => @truncate_columns,
    "writeBufferSize" => @write_buffer_size,
  })
  result.compact
end