AWS CloudFormation
User Guide (Version )

AWS::DMS::Endpoint S3Settings

Settings for exporting data to Amazon S3.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

Properties

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

Update requires: No interruption

BucketName

The name of the S3 bucket.

Required: No

Type: String

Update requires: No interruption

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. Applies to both CSV and PARQUET data formats.

Required: No

Type: String

Allowed Values: gzip | none

Update requires: No interruption

CsvDelimiter

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

Required: No

Type: String

Update requires: No interruption

CsvRowDelimiter

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

Required: No

Type: String

Update requires: No interruption

ExternalTableDefinition

The external table definition.

Required: No

Type: String

Update requires: No interruption

ServiceAccessRoleArn

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

Required: No

Type: String

Update requires: No interruption

On this page: