aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.DatabaseSourceConfigurationProperty

DatabaseSourceConfigurationProperty Struct

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

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

Source

Generated code

Type last changed

v2.168.0 · 20 Nov 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
const databaseSourceConfigurationProperty: kinesisfirehose.CfnDeliveryStream.DatabaseSourceConfigurationProperty = {
  databases: {
    exclude: ['exclude'],
    include: ['include'],
  },
  databaseSourceAuthenticationConfiguration: {
    secretsManagerConfiguration: {
      enabled: false,

      // the properties below are optional
      roleArn: 'roleArn',
      secretArn: 'secretArn',
    },
  },
  databaseSourceVpcConfiguration: {
    vpcEndpointServiceName: 'vpcEndpointServiceName',
  },
  endpoint: 'endpoint',
  port: 123,
  snapshotWatermarkTable: 'snapshotWatermarkTable',
  tables: {
    exclude: ['exclude'],
    include: ['include'],
  },
  type: 'type',

  // the properties below are optional
  columns: {
    exclude: ['exclude'],
    include: ['include'],
  },
  digest: 'digest',
  publicCertificate: 'publicCertificate',
  sslMode: 'sslMode',
  surrogateKeys: ['surrogateKeys'],
};

Properties

columns?optionalIResolvable | CfnDeliveryStream.DatabaseColumnsPropertycolumns?optionaltyping.Union[IResolvable, DatabaseColumnsProperty]columns?optionalIResolvableColumns?optionalIResolvableColumns?optionalinterface{}#

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.

databasesIResolvable | CfnDeliveryStream.DatabasesPropertydatabasestyping.Union[IResolvable, DatabasesProperty]databasesIResolvableDatabasesIResolvableDatabasesinterface{}required#

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.

databaseSourceAuthenticationConfigurationIResolvable | CfnDeliveryStream.DatabaseSourceAuthenticationConfigurationPropertydatabase_source_authentication_configurationtyping.Union[IResolvable, DatabaseSourceAuthenticationConfigurationProperty]databaseSourceAuthenticationConfigurationIResolvableDatabaseSourceAuthenticationConfigurationIResolvableDatabaseSourceAuthenticationConfigurationinterface{}required#

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.

databaseSourceVpcConfigurationIResolvable | CfnDeliveryStream.DatabaseSourceVPCConfigurationPropertydatabase_source_vpc_configurationtyping.Union[IResolvable, DatabaseSourceVPCConfigurationProperty]databaseSourceVpcConfigurationIResolvableDatabaseSourceVpcConfigurationIResolvableDatabaseSourceVpcConfigurationinterface{}required#

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.

digest?optionalstringdigest?optionalstrdigest?optionalStringDigest?optionalstringDigest?optional*string#

endpointstringendpointstrendpointStringEndpointstringEndpoint*stringrequired#

The endpoint of the database server.

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

portnumberportint | floatportNumberPortdoublePort*float64required#

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.

publicCertificate?optionalstringpublic_certificate?optionalstrpublicCertificate?optionalStringPublicCertificate?optionalstringPublicCertificate?optional*string#

snapshotWatermarkTablestringsnapshot_watermark_tablestrsnapshotWatermarkTableStringSnapshotWatermarkTablestringSnapshotWatermarkTable*stringrequired#

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.

sslMode?optionalstringssl_mode?optionalstrsslMode?optionalStringSslMode?optionalstringSslMode?optional*string#

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.

surrogateKeys?optionalstring[]surrogate_keys?optionaltyping.List[str]surrogateKeys?optionalList<String>SurrogateKeys?optionalstring[]SurrogateKeys?optional*[]*string#

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.

tablesIResolvable | CfnDeliveryStream.DatabaseTablesPropertytablestyping.Union[IResolvable, DatabaseTablesProperty]tablesIResolvableTablesIResolvableTablesinterface{}required#

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.

typestringtypestrtypeStringTypestringType*stringrequired#

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.