Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS DMS Endpoint S3Settings

Use the S3Settings property to specify settings for an Amazon S3 endpoint for a AWS::DMS::Endpoint resource.

Syntax

JSON

Copy
{ "BucketFolder" : String, "BucketName" : String, "CompressionType" : String, "CsvDelimiter" : String, "CsvRowDelimiter" : String, "ExternalTableDefinition" : String, "ServiceAccessRoleArn" : String }

YAML

Copy
BucketFolder: String BucketName: String CompressionType: String CsvDelimiter: String CsvRowDelimiter: String ExternalTableDefinition: String ServiceAccessRoleArn: String

Properties

For more information about option settings, see Using Amazon S3 as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide

BucketFolder

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

Required: No

Type: String

BucketName

The name of the Amazon S3 bucket.

Required: No

Type: String

CompressionType

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.

Valid Values: NONE | GZIP

Required: No

Type: String

CsvDelimiter

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

Required: No

Type: String

CsvRowDelimiter

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

Required: No

Type: String

ExternalTableDefinition

The definition of the external table.

Required: No

Type: String

ServiceAccessRoleArn

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

Required: No

Type: String

On this page: