Class CfnDeliveryStream.DatabaseSourceConfigurationProperty
The top level object for configuring streams with database as a source.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseSourceConfigurationProperty : Object, CfnDeliveryStream.IDatabaseSourceConfigurationPropertySyntax (vb)
Public Class DatabaseSourceConfigurationProperty
Inherits Object
Implements CfnDeliveryStream.IDatabaseSourceConfigurationPropertyRemarks
Amazon Data Firehose is in preview release and is subject to change.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisFirehose;
var databaseSourceConfigurationProperty = new DatabaseSourceConfigurationProperty {
Databases = new DatabasesProperty {
Exclude = new [] { "exclude" },
Include = new [] { "include" }
},
DatabaseSourceAuthenticationConfiguration = new DatabaseSourceAuthenticationConfigurationProperty {
SecretsManagerConfiguration = new SecretsManagerConfigurationProperty {
Enabled = false,
// the properties below are optional
RoleArn = "roleArn",
SecretArn = "secretArn"
}
},
DatabaseSourceVpcConfiguration = new DatabaseSourceVPCConfigurationProperty {
VpcEndpointServiceName = "vpcEndpointServiceName"
},
Endpoint = "endpoint",
Port = 123,
SnapshotWatermarkTable = "snapshotWatermarkTable",
Tables = new DatabaseTablesProperty {
Exclude = new [] { "exclude" },
Include = new [] { "include" }
},
Type = "type",
// the properties below are optional
Columns = new DatabaseColumnsProperty {
Exclude = new [] { "exclude" },
Include = new [] { "include" }
},
Digest = "digest",
PublicCertificate = "publicCertificate",
SslMode = "sslMode",
SurrogateKeys = new [] { "surrogateKeys" }
};Synopsis
Constructors
| Database |
Properties
| Columns | The list of column patterns in source database endpoint for Firehose to read from. |
| Databases | The list of database patterns in source database endpoint for Firehose to read from. |
| Database |
The structure to configure the authentication methods for Firehose to connect to source database endpoint. |
| Database |
The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. |
| Digest | |
| Endpoint | The endpoint of the database server. |
| Port | The port of the database. This can be one of the following values. |
| Public |
|
| Snapshot |
The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. |
| Ssl |
The mode to enable or disable SSL when Firehose connects to the database endpoint. |
| Surrogate |
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. |
| Tables | The list of table patterns in source database endpoint for Firehose to read from. |
| Type | The type of database engine. This can be one of the following values. |
Constructors
DatabaseSourceConfigurationProperty()
public DatabaseSourceConfigurationProperty()Properties
Columns
The list of column patterns in source database endpoint for Firehose to read from.
public object Columns { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
Databases
The list of database patterns in source database endpoint for Firehose to read from.
public object Databases { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
DatabaseSourceAuthenticationConfiguration
The structure to configure the authentication methods for Firehose to connect to source database endpoint.
public object DatabaseSourceAuthenticationConfiguration { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
DatabaseSourceVpcConfiguration
The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
public object DatabaseSourceVpcConfiguration { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
Digest
public string Digest { get; set; }Property Value
System.
Remarks
Endpoint
The endpoint of the database server.
public string Endpoint { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
Port
The port of the database. This can be one of the following values.
public double Port { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
PublicCertificate
public string PublicCertificate { get; set; }Property Value
System.
Remarks
SnapshotWatermarkTable
The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
public string SnapshotWatermarkTable { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
SslMode
The mode to enable or disable SSL when Firehose connects to the database endpoint.
public string SslMode { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
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.
public string[] SurrogateKeys { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
Tables
The list of table patterns in source database endpoint for Firehose to read from.
public object Tables { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
Type
The type of database engine. This can be one of the following values.
public string Type { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.