Class CfnDeliveryStream.DatabaseSourceConfigurationProperty

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

Inheritance

object

CfnDeliveryStream.DatabaseSourceConfigurationProperty

Implements

CfnDeliveryStream.IDatabaseSourceConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeliveryStream.DatabaseSourceConfigurationProperty : CfnDeliveryStream.IDatabaseSourceConfigurationProperty

Syntax (vb)

Public Class CfnDeliveryStream.DatabaseSourceConfigurationProperty Implements CfnDeliveryStream.IDatabaseSourceConfigurationProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html

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

DatabaseSourceConfigurationProperty()

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

Properties

Columns	The list of column patterns in source database endpoint for Firehose to read from.
DatabaseSourceAuthenticationConfiguration	The structure to configure the authentication methods for Firehose to connect to source database endpoint.
DatabaseSourceVpcConfiguration	The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
Databases	The list of database patterns in source database endpoint for Firehose to read from.
Digest	The top level object for configuring streams with database as a source.
Endpoint	The endpoint of the database server.
Port	The port of the database. This can be one of the following values.
PublicCertificate	The top level object for configuring streams with database as a source.
SnapshotWatermarkTable	The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
SslMode	The mode to enable or disable SSL when Firehose connects to the database endpoint.
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.
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()

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

public DatabaseSourceConfigurationProperty()

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html

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" }
             };

Properties

Columns

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

public object? Columns { get; set; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-columns

DatabaseSourceAuthenticationConfiguration

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

public object DatabaseSourceAuthenticationConfiguration { get; set; }

Property Value

object

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

object

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

object

Remarks

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

Digest

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

public string? Digest { get; set; }

Property Value

string

Remarks

Endpoint

The endpoint of the database server.

public string Endpoint { get; set; }

Property Value

string

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

double

Remarks

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

PublicCertificate

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

public string? PublicCertificate { get; set; }

Property Value

string

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

string

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

string

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

string[]

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

object

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

string

Remarks

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

Implements

CfnDeliveryStream.IDatabaseSourceConfigurationProperty