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

Class: Aws::DatabaseMigrationService::Types::S3Settings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass S3Settings data as a hash:

{
  service_access_role_arn: "String",
  external_table_definition: "String",
  csv_row_delimiter: "String",
  csv_delimiter: "String",
  bucket_folder: "String",
  bucket_name: "String",
  compression_type: "none", # accepts none, gzip
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_folderString

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 is not specified, then the path used is <schema_name>/<table_name>/.

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end

#bucket_nameString

The name of the S3 bucket.

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end

#compression_typeString

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end

#csv_delimiterString

The delimiter used to separate columns in the source files. The default is a comma.

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end

#csv_row_delimiterString

The delimiter used to separate rows in the source files. The default is a carriage return (\n).

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end

#external_table_definitionString

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end

#service_access_role_arnString

The Amazon Resource Name (ARN) used by the service access IAM role.

Returns:

  • (String)


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3447

class S3Settings < Struct.new(
  :service_access_role_arn,
  :external_table_definition,
  :csv_row_delimiter,
  :csv_delimiter,
  :bucket_folder,
  :bucket_name,
  :compression_type)
  include Aws::Structure
end