Class: AWSCDK::DMS::CfnEndpoint::S3SettingsProperty

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

Overview

Provides information that defines an Amazon S3 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 the available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 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(add_column_name: nil, add_trailing_padding_character: nil, bucket_folder: nil, bucket_name: nil, canned_acl_for_objects: nil, cdc_inserts_and_updates: nil, cdc_inserts_only: nil, cdc_max_batch_interval: nil, cdc_min_file_size: nil, cdc_path: nil, compression_type: nil, csv_delimiter: nil, csv_no_sup_value: nil, csv_null_value: nil, csv_row_delimiter: nil, data_format: nil, data_page_size: nil, date_partition_delimiter: nil, date_partition_enabled: nil, date_partition_sequence: nil, date_partition_timezone: nil, dict_page_size_limit: nil, enable_statistics: nil, encoding_type: nil, encryption_mode: nil, expected_bucket_owner: nil, external_table_definition: nil, glue_catalog_generation: nil, ignore_header_rows: nil, include_op_for_full_load: nil, max_file_size: nil, parquet_timestamp_in_millisecond: nil, parquet_version: nil, preserve_transactions: nil, rfc4180: nil, row_group_length: nil, server_side_encryption_kms_key_id: nil, service_access_role_arn: nil, timestamp_column_name: nil, use_csv_no_sup_value: nil, use_task_start_time_for_full_load_timestamp: nil) ⇒ S3SettingsProperty

Returns a new instance of S3SettingsProperty.

Parameters:

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

    An optional parameter that, when set to true or y , you can use to add column name information to the .csv output file.

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

    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data.

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

    An optional parameter to set a folder name in the S3 bucket.

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

    The name of the S3 bucket.

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

    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 Developer Guide .

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

    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is false , but when CdcInsertsAndUpdates is set to true or y , only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.

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

    A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.

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

    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.

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

    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.

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

    Specifies the folder path of CDC files.

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

    An optional parameter.

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

    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.

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

    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.

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

    An optional parameter that specifies how AWS DMS treats null values.

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

    The delimiter used to separate rows in the .csv file for both source and target.

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

    The format of the data that you want to use for output. You can choose one of the following:.

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

    The size of one data page in bytes.

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

    Specifies a date separating delimiter to use during folder partitioning.

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

    When set to true , this parameter partitions S3 bucket folders based on transaction commit dates.

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

    Identifies the sequence of the date format to use during folder partitioning.

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

    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.

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

    The maximum size of an encoded dictionary page of a column.

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

    A value that enables statistics for Parquet pages and row groups.

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

    The type of encoding that you're using:.

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

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

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

    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.

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

    The external table definition.

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

    When true, allows AWS Glue to catalog your S3 bucket.

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

    When this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.

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

    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.

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

    A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.

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

    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.

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

    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .

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

    If this setting is set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .

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

    For an S3 source, when this value is set to true or y , each leading double quotation mark has to be followed by an ending double quotation mark.

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

    The number of rows in a row group.

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

    If you are using SSE_KMS for the EncryptionMode , provide the AWS key ID.

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

    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.

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

    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.

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

    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue . If this setting isn't set or is set to false , AWS DMS uses the null value for these columns.

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

    When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target.



3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
 
# File 'dms/cfn_endpoint.rb', line 3648

def initialize(add_column_name: nil, add_trailing_padding_character: nil, bucket_folder: nil, bucket_name: nil, canned_acl_for_objects: nil, cdc_inserts_and_updates: nil, cdc_inserts_only: nil, cdc_max_batch_interval: nil, cdc_min_file_size: nil, cdc_path: nil, compression_type: nil, csv_delimiter: nil, csv_no_sup_value: nil, csv_null_value: nil, csv_row_delimiter: nil, data_format: nil, data_page_size: nil, date_partition_delimiter: nil, date_partition_enabled: nil, date_partition_sequence: nil, date_partition_timezone: nil, dict_page_size_limit: nil, enable_statistics: nil, encoding_type: nil, encryption_mode: nil, expected_bucket_owner: nil, external_table_definition: nil, glue_catalog_generation: nil, ignore_header_rows: nil, include_op_for_full_load: nil, max_file_size: nil, parquet_timestamp_in_millisecond: nil, parquet_version: nil, preserve_transactions: nil, rfc4180: nil, row_group_length: nil, server_side_encryption_kms_key_id: nil, service_access_role_arn: nil, timestamp_column_name: nil, use_csv_no_sup_value: nil, use_task_start_time_for_full_load_timestamp: nil)
  @add_column_name = add_column_name
  Jsii::Type.check_type(@add_column_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "addColumnName") unless @add_column_name.nil?
  @add_trailing_padding_character = add_trailing_padding_character
  Jsii::Type.check_type(@add_trailing_padding_character, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "addTrailingPaddingCharacter") unless @add_trailing_padding_character.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?
  @canned_acl_for_objects = canned_acl_for_objects
  Jsii::Type.check_type(@canned_acl_for_objects, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cannedAclForObjects") unless @canned_acl_for_objects.nil?
  @cdc_inserts_and_updates = cdc_inserts_and_updates
  Jsii::Type.check_type(@cdc_inserts_and_updates, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "cdcInsertsAndUpdates") unless @cdc_inserts_and_updates.nil?
  @cdc_inserts_only = cdc_inserts_only
  Jsii::Type.check_type(@cdc_inserts_only, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "cdcInsertsOnly") unless @cdc_inserts_only.nil?
  @cdc_max_batch_interval = cdc_max_batch_interval
  Jsii::Type.check_type(@cdc_max_batch_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cdcMaxBatchInterval") unless @cdc_max_batch_interval.nil?
  @cdc_min_file_size = cdc_min_file_size
  Jsii::Type.check_type(@cdc_min_file_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cdcMinFileSize") unless @cdc_min_file_size.nil?
  @cdc_path = cdc_path
  Jsii::Type.check_type(@cdc_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdcPath") unless @cdc_path.nil?
  @compression_type = compression_type
  Jsii::Type.check_type(@compression_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "compressionType") unless @compression_type.nil?
  @csv_delimiter = csv_delimiter
  Jsii::Type.check_type(@csv_delimiter, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "csvDelimiter") unless @csv_delimiter.nil?
  @csv_no_sup_value = csv_no_sup_value
  Jsii::Type.check_type(@csv_no_sup_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "csvNoSupValue") unless @csv_no_sup_value.nil?
  @csv_null_value = csv_null_value
  Jsii::Type.check_type(@csv_null_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "csvNullValue") unless @csv_null_value.nil?
  @csv_row_delimiter = csv_row_delimiter
  Jsii::Type.check_type(@csv_row_delimiter, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "csvRowDelimiter") unless @csv_row_delimiter.nil?
  @data_format = data_format
  Jsii::Type.check_type(@data_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataFormat") unless @data_format.nil?
  @data_page_size = data_page_size
  Jsii::Type.check_type(@data_page_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dataPageSize") unless @data_page_size.nil?
  @date_partition_delimiter = date_partition_delimiter
  Jsii::Type.check_type(@date_partition_delimiter, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datePartitionDelimiter") unless @date_partition_delimiter.nil?
  @date_partition_enabled = date_partition_enabled
  Jsii::Type.check_type(@date_partition_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "datePartitionEnabled") unless @date_partition_enabled.nil?
  @date_partition_sequence = date_partition_sequence
  Jsii::Type.check_type(@date_partition_sequence, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datePartitionSequence") unless @date_partition_sequence.nil?
  @date_partition_timezone = date_partition_timezone
  Jsii::Type.check_type(@date_partition_timezone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datePartitionTimezone") unless @date_partition_timezone.nil?
  @dict_page_size_limit = dict_page_size_limit
  Jsii::Type.check_type(@dict_page_size_limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dictPageSizeLimit") unless @dict_page_size_limit.nil?
  @enable_statistics = enable_statistics
  Jsii::Type.check_type(@enable_statistics, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableStatistics") unless @enable_statistics.nil?
  @encoding_type = encoding_type
  Jsii::Type.check_type(@encoding_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encodingType") unless @encoding_type.nil?
  @encryption_mode = encryption_mode
  Jsii::Type.check_type(@encryption_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionMode") unless @encryption_mode.nil?
  @expected_bucket_owner = expected_bucket_owner
  Jsii::Type.check_type(@expected_bucket_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expectedBucketOwner") unless @expected_bucket_owner.nil?
  @external_table_definition = external_table_definition
  Jsii::Type.check_type(@external_table_definition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "externalTableDefinition") unless @external_table_definition.nil?
  @glue_catalog_generation = glue_catalog_generation
  Jsii::Type.check_type(@glue_catalog_generation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "glueCatalogGeneration") unless @glue_catalog_generation.nil?
  @ignore_header_rows = ignore_header_rows
  Jsii::Type.check_type(@ignore_header_rows, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ignoreHeaderRows") unless @ignore_header_rows.nil?
  @include_op_for_full_load = include_op_for_full_load
  Jsii::Type.check_type(@include_op_for_full_load, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "includeOpForFullLoad") unless @include_op_for_full_load.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?
  @parquet_timestamp_in_millisecond = parquet_timestamp_in_millisecond
  Jsii::Type.check_type(@parquet_timestamp_in_millisecond, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "parquetTimestampInMillisecond") unless @parquet_timestamp_in_millisecond.nil?
  @parquet_version = parquet_version
  Jsii::Type.check_type(@parquet_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parquetVersion") unless @parquet_version.nil?
  @preserve_transactions = preserve_transactions
  Jsii::Type.check_type(@preserve_transactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "preserveTransactions") unless @preserve_transactions.nil?
  @rfc4180 = rfc4180
  Jsii::Type.check_type(@rfc4180, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "rfc4180") unless @rfc4180.nil?
  @row_group_length = row_group_length
  Jsii::Type.check_type(@row_group_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "rowGroupLength") unless @row_group_length.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?
  @timestamp_column_name = timestamp_column_name
  Jsii::Type.check_type(@timestamp_column_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timestampColumnName") unless @timestamp_column_name.nil?
  @use_csv_no_sup_value = use_csv_no_sup_value
  Jsii::Type.check_type(@use_csv_no_sup_value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useCsvNoSupValue") unless @use_csv_no_sup_value.nil?
  @use_task_start_time_for_full_load_timestamp = use_task_start_time_for_full_load_timestamp
  Jsii::Type.check_type(@use_task_start_time_for_full_load_timestamp, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useTaskStartTimeForFullLoadTimestamp") unless @use_task_start_time_for_full_load_timestamp.nil?
end

Instance Attribute Details

#add_column_name ⇒ Boolean, ... (readonly)

An optional parameter that, when set to true or y , you can use to add column name information to the .csv output file.

The default value is false . Valid values are true , false , y , and n .

Returns:

See Also:



3739
3740
3741
 
# File 'dms/cfn_endpoint.rb', line 3739

def add_column_name
  @add_column_name
end

#add_trailing_padding_character ⇒ Boolean, ... (readonly)

Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data.

The default value is false .

Returns:

See Also:



3746
3747
3748
 
# File 'dms/cfn_endpoint.rb', line 3746

def add_trailing_padding_character
  @add_trailing_padding_character
end

#bucket_folder ⇒ String? (readonly)

An optional parameter to set a folder name in the S3 bucket.

If provided, tables are created in the path *bucketFolder* / *schema_name* / *table_name* / . If this parameter isn't specified, the path used is *schema_name* / *table_name* / .

Returns:

  • (String, nil)

See Also:



3753
3754
3755
 
# File 'dms/cfn_endpoint.rb', line 3753

def bucket_folder
  @bucket_folder
end

#bucket_name ⇒ String? (readonly)

The name of the S3 bucket.

Returns:

  • (String, nil)

See Also:



3758
3759
3760
 
# File 'dms/cfn_endpoint.rb', line 3758

def bucket_name
  @bucket_name
end

#canned_acl_for_objects ⇒ String? (readonly)

A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 Developer Guide .

The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.

Returns:

  • (String, nil)

See Also:



3765
3766
3767
 
# File 'dms/cfn_endpoint.rb', line 3765

def canned_acl_for_objects
  @canned_acl_for_objects
end

#cdc_inserts_and_updates ⇒ Boolean, ... (readonly)

A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is false , but when CdcInsertsAndUpdates is set to true or y , only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.

For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the IncludeOpForFullLoad parameter. If IncludeOpForFullLoad is set to true , the first field of every CDC record is set to either I or U to indicate INSERT and UPDATE operations at the source. But if IncludeOpForFullLoad is set to false , CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide .

AWS DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later.

CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.

Returns:

See Also:



3776
3777
3778
 
# File 'dms/cfn_endpoint.rb', line 3776

def cdc_inserts_and_updates
  @cdc_inserts_and_updates
end

#cdc_inserts_only ⇒ Boolean, ... (readonly)

A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.

If CdcInsertsOnly is set to true or y , only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of IncludeOpForFullLoad . If IncludeOpForFullLoad is set to true , the first field of every CDC record is set to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is set to false , every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide .

AWS DMS supports the interaction described preceding between the CdcInsertsOnly and IncludeOpForFullLoad parameters in versions 3.1.4 and later.

CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.

Returns:

See Also:



3787
3788
3789
 
# File 'dms/cfn_endpoint.rb', line 3787

def cdc_inserts_only
  @cdc_inserts_only
end

#cdc_max_batch_interval ⇒ Numeric? (readonly)

Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.

When CdcMaxBatchInterval and CdcMinFileSize are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.

The default value is 60 seconds.

Returns:

  • (Numeric, nil)

See Also:



3796
3797
3798
 
# File 'dms/cfn_endpoint.rb', line 3796

def cdc_max_batch_interval
  @cdc_max_batch_interval
end

#cdc_min_file_size ⇒ Numeric? (readonly)

Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.

When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.

The default value is 32 MB.

Returns:

  • (Numeric, nil)

See Also:



3805
3806
3807
 
# File 'dms/cfn_endpoint.rb', line 3805

def cdc_min_file_size
  @cdc_min_file_size
end

#cdc_path ⇒ String? (readonly)

Specifies the folder path of CDC files.

For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set PreserveTransactions to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by BucketFolder and BucketName .

For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS DMS creates the CDC folder path following: MyTargetBucket/MyChangedData .

If you specify the same CdcPath , and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData , AWS DMS creates the CDC folder path following: MyTargetBucket/MyTargetData/MyChangedData .

For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target .

This setting is supported in AWS DMS versions 3.4.2 and later.

Returns:

  • (String, nil)

See Also:



3820
3821
3822
 
# File 'dms/cfn_endpoint.rb', line 3820

def cdc_path
  @cdc_path
end

#compression_type ⇒ String? (readonly)

An optional parameter.

When set to GZIP it enables the service to compress the target files. To allow the service to write the target files uncompressed, either set this parameter to NONE (the default) or don't specify the parameter at all. This parameter applies to both .csv and .parquet file formats.

Returns:

  • (String, nil)

See Also:



3827
3828
3829
 
# File 'dms/cfn_endpoint.rb', line 3827

def compression_type
  @compression_type
end

#csv_delimiter ⇒ String? (readonly)

The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.

Returns:

  • (String, nil)

See Also:



3832
3833
3834
 
# File 'dms/cfn_endpoint.rb', line 3832

def csv_delimiter
  @csv_delimiter
end

#csv_no_sup_value ⇒ String? (readonly)

This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.

This setting is supported in AWS DMS versions 3.4.1 and later.

Returns:

  • (String, nil)

See Also:



3839
3840
3841
 
# File 'dms/cfn_endpoint.rb', line 3839

def csv_no_sup_value
  @csv_no_sup_value
end

#csv_null_value ⇒ String? (readonly)

An optional parameter that specifies how AWS DMS treats null values.

While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), AWS DMS treats the empty string as the null value instead of NULL .

The default value is NULL . Valid values include any valid string.

Returns:

  • (String, nil)

See Also:



3848
3849
3850
 
# File 'dms/cfn_endpoint.rb', line 3848

def csv_null_value
  @csv_null_value
end

#csv_row_delimiter ⇒ String? (readonly)

The delimiter used to separate rows in the .csv file for both source and target.

The default is a carriage return ( \n ).

Returns:

  • (String, nil)

See Also:



3855
3856
3857
 
# File 'dms/cfn_endpoint.rb', line 3855

def csv_row_delimiter
  @csv_row_delimiter
end

#data_format ⇒ String? (readonly)

The format of the data that you want to use for output. You can choose one of the following:.

  • csv : This is a row-based file format with comma-separated values (.csv).
  • parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.

Returns:

  • (String, nil)

See Also:



3863
3864
3865
 
# File 'dms/cfn_endpoint.rb', line 3863

def data_format
  @data_format
end

#data_page_size ⇒ Numeric? (readonly)

The size of one data page in bytes.

This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.

Returns:

  • (Numeric, nil)

See Also:



3870
3871
3872
 
# File 'dms/cfn_endpoint.rb', line 3870

def data_page_size
  @data_page_size
end

#date_partition_delimiter ⇒ String? (readonly)

Specifies a date separating delimiter to use during folder partitioning.

The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .

Returns:

  • (String, nil)

See Also:



3877
3878
3879
 
# File 'dms/cfn_endpoint.rb', line 3877

def date_partition_delimiter
  @date_partition_delimiter
end

#date_partition_enabled ⇒ Boolean, ... (readonly)

When set to true , this parameter partitions S3 bucket folders based on transaction commit dates.

The default value is false . For more information about date-based folder partitioning, see Using date-based folder partitioning .

Returns:

See Also:



3884
3885
3886
 
# File 'dms/cfn_endpoint.rb', line 3884

def date_partition_enabled
  @date_partition_enabled
end

#date_partition_sequence ⇒ String? (readonly)

Identifies the sequence of the date format to use during folder partitioning.

The default value is YYYYMMDD . Use this parameter when DatePartitionedEnabled is set to true .

Returns:

  • (String, nil)

See Also:



3891
3892
3893
 
# File 'dms/cfn_endpoint.rb', line 3891

def date_partition_sequence
  @date_partition_sequence
end

#date_partition_timezone ⇒ String? (readonly)

When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.

The conversion occurs when a date partition folder is created and a change data capture (CDC) file name is generated. The time zone format is Area/Location. Use this parameter when DatePartitionedEnabled is set to true , as shown in the following example.

s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":" *Asia/Seoul* ", "BucketName": "dms-nattarat-test"}'

Returns:

  • (String, nil)

See Also:



3900
3901
3902
 
# File 'dms/cfn_endpoint.rb', line 3900

def date_partition_timezone
  @date_partition_timezone
end

#dict_page_size_limit ⇒ Numeric? (readonly)

The maximum size of an encoded dictionary page of a column.

If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for .parquet file format only.

Returns:

  • (Numeric, nil)

See Also:



3907
3908
3909
 
# File 'dms/cfn_endpoint.rb', line 3907

def dict_page_size_limit
  @dict_page_size_limit
end

#enable_statistics ⇒ Boolean, ... (readonly)

A value that enables statistics for Parquet pages and row groups.

Choose true to enable statistics, false to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. This parameter defaults to true . This value is used for .parquet file format only.

Returns:

See Also:



3914
3915
3916
 
# File 'dms/cfn_endpoint.rb', line 3914

def enable_statistics
  @enable_statistics
end

#encoding_type ⇒ String? (readonly)

The type of encoding that you're using:.

  • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.
  • PLAIN doesn't use encoding at all. Values are stored as they are.
  • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

Returns:

  • (String, nil)

See Also:



3923
3924
3925
 
# File 'dms/cfn_endpoint.rb', line 3923

def encoding_type
  @encoding_type
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 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

  • s3:CreateBucket
  • s3:ListBucket
  • s3:DeleteBucket
  • s3:GetBucketLocation
  • s3:GetObject
  • s3:PutObject
  • s3:DeleteObject
  • s3:GetObjectVersion
  • s3:GetBucketPolicy
  • s3:PutBucketPolicy
  • s3:DeleteBucketPolicy

Returns:

  • (String, nil)

See Also:



3946
3947
3948
 
# File 'dms/cfn_endpoint.rb', line 3946

def encryption_mode
  @encryption_mode
end

#expected_bucket_owner ⇒ String? (readonly)

To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.

Example: --s3-settings='{"ExpectedBucketOwner": " *AWS_Account_ID* "}'

When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter.

Returns:

  • (String, nil)

See Also:



3955
3956
3957
 
# File 'dms/cfn_endpoint.rb', line 3955

def expected_bucket_owner
  @expected_bucket_owner
end

#external_table_definition ⇒ String? (readonly)

The external table definition.

Conditional: If S3 is used as a source then ExternalTableDefinition is required.

Returns:

  • (String, nil)

See Also:



3962
3963
3964
 
# File 'dms/cfn_endpoint.rb', line 3962

def external_table_definition
  @external_table_definition
end

#glue_catalog_generation ⇒ Boolean, ... (readonly)

When true, allows AWS Glue to catalog your S3 bucket.

Creating an AWS Glue catalog lets you use Athena to query your data.

Returns:

See Also:



3969
3970
3971
 
# File 'dms/cfn_endpoint.rb', line 3969

def glue_catalog_generation
  @glue_catalog_generation
end

#ignore_header_rows ⇒ Numeric? (readonly)

When this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.

The default is 0.

Returns:

  • (Numeric, nil)

See Also:



3976
3977
3978
 
# File 'dms/cfn_endpoint.rb', line 3976

def ignore_header_rows
  @ignore_header_rows
end

#include_op_for_full_load ⇒ Boolean, ... (readonly)

A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.

AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later.

For full load, records can only be inserted. By default (the false setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If IncludeOpForFullLoad is set to true or y , the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.

This setting works together with the CdcInsertsOnly and the CdcInsertsAndUpdates parameters for output to .csv files only. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide .

Returns:

See Also:



3987
3988
3989
 
# File 'dms/cfn_endpoint.rb', line 3987

def include_op_for_full_load
  @include_op_for_full_load
end

#max_file_size ⇒ Numeric? (readonly)

A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.

The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.

Returns:

  • (Numeric, nil)

See Also:



3994
3995
3996
 
# File 'dms/cfn_endpoint.rb', line 3994

def max_file_size
  @max_file_size
end

#parquet_timestamp_in_millisecond ⇒ Boolean, ... (readonly)

A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.

AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.

When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.

Currently, Amazon Athena and AWS Glue can handle only millisecond precision for TIMESTAMP values. Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue .

AWS DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision.

Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.

Returns:

See Also:



4009
4010
4011
 
# File 'dms/cfn_endpoint.rb', line 4009

def parquet_timestamp_in_millisecond
  @parquet_timestamp_in_millisecond
end

#parquet_version ⇒ String? (readonly)

The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .

Returns:

  • (String, nil)

See Also:



4014
4015
4016
 
# File 'dms/cfn_endpoint.rb', line 4014

def parquet_version
  @parquet_version
end

#preserve_transactions ⇒ Boolean, ... (readonly)

If this setting is set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .

This setting is supported in AWS DMS versions 3.4.2 and later.

Returns:

See Also:



4021
4022
4023
 
# File 'dms/cfn_endpoint.rb', line 4021

def preserve_transactions
  @preserve_transactions
end

#rfc4180 ⇒ Boolean, ... (readonly)

For an S3 source, when this value is set to true or y , each leading double quotation mark has to be followed by an ending double quotation mark.

This formatting complies with RFC 4180. When this value is set to false or n , string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.

For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to true or y using Amazon S3 as a target, if the data has quotation marks or newline characters in it, AWS DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.

The default value is true . Valid values include true , false , y , and n .

Returns:

See Also:



4032
4033
4034
 
# File 'dms/cfn_endpoint.rb', line 4032

def rfc4180
  @rfc4180
end

#row_group_length ⇒ Numeric? (readonly)

The number of rows in a row group.

A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.

If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

Returns:

  • (Numeric, nil)

See Also:



4041
4042
4043
 
# File 'dms/cfn_endpoint.rb', line 4041

def row_group_length
  @row_group_length
end

#server_side_encryption_kms_key_id ⇒ String? (readonly)

If you are using SSE_KMS for the EncryptionMode , provide the AWS key ID.

The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.

Here is a CLI example: aws dms create-endpoint --endpoint-identifier *value* --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn= *value* ,BucketFolder= *value* ,BucketName= *value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId= *value*

Returns:

  • (String, nil)

See Also:



4050
4051
4052
 
# File 'dms/cfn_endpoint.rb', line 4050

def server_side_encryption_kms_key_id
  @server_side_encryption_kms_key_id
end

#service_access_role_arn ⇒ String? (readonly)

A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.

The role must allow the iam:PassRole action. It enables AWS DMS to read and write objects from an S3 bucket.

Returns:

  • (String, nil)

See Also:



4057
4058
4059
 
# File 'dms/cfn_endpoint.rb', line 4057

def service_access_role_arn
  @service_access_role_arn
end

#timestamp_column_name ⇒ String? (readonly)

A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.

AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

AWS DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data when you set TimestampColumnName to a nonblank value.

For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.

For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.

The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS . By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.

When the AddColumnName parameter is set to true , DMS also includes a name for the timestamp column that you set with TimestampColumnName .

Returns:

  • (String, nil)

See Also:



4074
4075
4076
 
# File 'dms/cfn_endpoint.rb', line 4074

def timestamp_column_name
  @timestamp_column_name
end

#use_csv_no_sup_value ⇒ Boolean, ... (readonly)

This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue . If this setting isn't set or is set to false , AWS DMS uses the null value for these columns.

This setting is supported in AWS DMS versions 3.4.1 and later.

Returns:

See Also:



4081
4082
4083
 
# File 'dms/cfn_endpoint.rb', line 4081

def use_csv_no_sup_value
  @use_csv_no_sup_value
end

#use_task_start_time_for_full_load_timestamp ⇒ Boolean, ... (readonly)

When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target.

For full load, when use_task_start_time_for_full_load_timestamp is set to true , each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.

When use_task_start_time_for_full_load_timestamp is set to false , the full load timestamp in the timestamp column increments with the time data arrives at the target.

Returns:

See Also:



4090
4091
4092
 
# File 'dms/cfn_endpoint.rb', line 4090

def use_task_start_time_for_full_load_timestamp
  @use_task_start_time_for_full_load_timestamp
end

Class Method Details

.jsii_properties ⇒ Object 



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
 
# File 'dms/cfn_endpoint.rb', line 4092

def self.jsii_properties
  {
    :add_column_name => "addColumnName",
    :add_trailing_padding_character => "addTrailingPaddingCharacter",
    :bucket_folder => "bucketFolder",
    :bucket_name => "bucketName",
    :canned_acl_for_objects => "cannedAclForObjects",
    :cdc_inserts_and_updates => "cdcInsertsAndUpdates",
    :cdc_inserts_only => "cdcInsertsOnly",
    :cdc_max_batch_interval => "cdcMaxBatchInterval",
    :cdc_min_file_size => "cdcMinFileSize",
    :cdc_path => "cdcPath",
    :compression_type => "compressionType",
    :csv_delimiter => "csvDelimiter",
    :csv_no_sup_value => "csvNoSupValue",
    :csv_null_value => "csvNullValue",
    :csv_row_delimiter => "csvRowDelimiter",
    :data_format => "dataFormat",
    :data_page_size => "dataPageSize",
    :date_partition_delimiter => "datePartitionDelimiter",
    :date_partition_enabled => "datePartitionEnabled",
    :date_partition_sequence => "datePartitionSequence",
    :date_partition_timezone => "datePartitionTimezone",
    :dict_page_size_limit => "dictPageSizeLimit",
    :enable_statistics => "enableStatistics",
    :encoding_type => "encodingType",
    :encryption_mode => "encryptionMode",
    :expected_bucket_owner => "expectedBucketOwner",
    :external_table_definition => "externalTableDefinition",
    :glue_catalog_generation => "glueCatalogGeneration",
    :ignore_header_rows => "ignoreHeaderRows",
    :include_op_for_full_load => "includeOpForFullLoad",
    :max_file_size => "maxFileSize",
    :parquet_timestamp_in_millisecond => "parquetTimestampInMillisecond",
    :parquet_version => "parquetVersion",
    :preserve_transactions => "preserveTransactions",
    :rfc4180 => "rfc4180",
    :row_group_length => "rowGroupLength",
    :server_side_encryption_kms_key_id => "serverSideEncryptionKmsKeyId",
    :service_access_role_arn => "serviceAccessRoleArn",
    :timestamp_column_name => "timestampColumnName",
    :use_csv_no_sup_value => "useCsvNoSupValue",
    :use_task_start_time_for_full_load_timestamp => "useTaskStartTimeForFullLoadTimestamp",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
 
# File 'dms/cfn_endpoint.rb', line 4138

def to_jsii
  result = {}
  result.merge!({
    "addColumnName" => @add_column_name,
    "addTrailingPaddingCharacter" => @add_trailing_padding_character,
    "bucketFolder" => @bucket_folder,
    "bucketName" => @bucket_name,
    "cannedAclForObjects" => @canned_acl_for_objects,
    "cdcInsertsAndUpdates" => @cdc_inserts_and_updates,
    "cdcInsertsOnly" => @cdc_inserts_only,
    "cdcMaxBatchInterval" => @cdc_max_batch_interval,
    "cdcMinFileSize" => @cdc_min_file_size,
    "cdcPath" => @cdc_path,
    "compressionType" => @compression_type,
    "csvDelimiter" => @csv_delimiter,
    "csvNoSupValue" => @csv_no_sup_value,
    "csvNullValue" => @csv_null_value,
    "csvRowDelimiter" => @csv_row_delimiter,
    "dataFormat" => @data_format,
    "dataPageSize" => @data_page_size,
    "datePartitionDelimiter" => @date_partition_delimiter,
    "datePartitionEnabled" => @date_partition_enabled,
    "datePartitionSequence" => @date_partition_sequence,
    "datePartitionTimezone" => @date_partition_timezone,
    "dictPageSizeLimit" => @dict_page_size_limit,
    "enableStatistics" => @enable_statistics,
    "encodingType" => @encoding_type,
    "encryptionMode" => @encryption_mode,
    "expectedBucketOwner" => @expected_bucket_owner,
    "externalTableDefinition" => @external_table_definition,
    "glueCatalogGeneration" => @glue_catalog_generation,
    "ignoreHeaderRows" => @ignore_header_rows,
    "includeOpForFullLoad" => @include_op_for_full_load,
    "maxFileSize" => @max_file_size,
    "parquetTimestampInMillisecond" => @parquet_timestamp_in_millisecond,
    "parquetVersion" => @parquet_version,
    "preserveTransactions" => @preserve_transactions,
    "rfc4180" => @rfc4180,
    "rowGroupLength" => @row_group_length,
    "serverSideEncryptionKmsKeyId" => @server_side_encryption_kms_key_id,
    "serviceAccessRoleArn" => @service_access_role_arn,
    "timestampColumnName" => @timestamp_column_name,
    "useCsvNoSupValue" => @use_csv_no_sup_value,
    "useTaskStartTimeForFullLoadTimestamp" => @use_task_start_time_for_full_load_timestamp,
  })
  result.compact
end