AWS::KinesisFirehose::DeliveryStream DatabaseSourceConfiguration - AWS CloudFormation
SyntaxProperties

AWS::KinesisFirehose::DeliveryStream DatabaseSourceConfiguration

The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.

Syntax

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

Properties

Columns

The list of column patterns in source database endpoint for Firehose to read from.

Amazon Data Firehose is in preview release and is subject to change.

Required: No

Type: DatabaseColumns

Update requires: Replacement

Databases

The list of database patterns in source database endpoint for Firehose to read from.

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: Databases

Update requires: Replacement

DatabaseSourceAuthenticationConfiguration

The structure to configure the authentication methods for Firehose to connect to source database endpoint.

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: DatabaseSourceAuthenticationConfiguration

Update requires: Replacement

DatabaseSourceVPCConfiguration

The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: DatabaseSourceVPCConfiguration

Update requires: Replacement

Digest

Property description not available.

Required: No

Type: String

Pattern: .*

Minimum: 1

Maximum: 512

Update requires: Replacement

Endpoint

The endpoint of the database server.

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: String

Pattern: ^(?!\s*$).+

Minimum: 1

Maximum: 255

Update requires: Replacement

Port

The port of the database. This can be one of the following values.

  • 3306 for MySQL database type

  • 5432 for PostgreSQL database type

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: Integer

Minimum: 0

Maximum: 65535

Update requires: Replacement

PublicCertificate

Property description not available.

Required: No

Type: String

Pattern: .*

Minimum: 1

Maximum: 4096

Update requires: Replacement

SnapshotWatermarkTable

The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: String

Pattern: [\u0001-\uFFFF]*

Minimum: 1

Maximum: 129

Update requires: Replacement

SSLMode

The mode to enable or disable SSL when Firehose connects to the database endpoint.

Amazon Data Firehose is in preview release and is subject to change.

Required: No

Type: String

Allowed values: Disabled | Enabled

Update requires: Replacement

SurrogateKeys

The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.

Amazon Data Firehose is in preview release and is subject to change.

Required: No

Type: Array of String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Tables

The list of table patterns in source database endpoint for Firehose to read from.

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: DatabaseTables

Update requires: Replacement

Type

The type of database engine. This can be one of the following values.

  • MySQL

  • PostgreSQL

Amazon Data Firehose is in preview release and is subject to change.

Required: Yes

Type: String

Allowed values: MySQL | PostgreSQL

Update requires: Replacement