Interface CfnDeliveryStream.DatabaseSourceConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStream.DatabaseSourceConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStream
Amazon Data Firehose is in preview release and is subject to change.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kinesisfirehose.*;
DatabaseSourceConfigurationProperty databaseSourceConfigurationProperty = DatabaseSourceConfigurationProperty.builder()
.databases(DatabasesProperty.builder()
.exclude(List.of("exclude"))
.include(List.of("include"))
.build())
.databaseSourceAuthenticationConfiguration(DatabaseSourceAuthenticationConfigurationProperty.builder()
.secretsManagerConfiguration(SecretsManagerConfigurationProperty.builder()
.enabled(false)
// the properties below are optional
.roleArn("roleArn")
.secretArn("secretArn")
.build())
.build())
.databaseSourceVpcConfiguration(DatabaseSourceVPCConfigurationProperty.builder()
.vpcEndpointServiceName("vpcEndpointServiceName")
.build())
.endpoint("endpoint")
.port(123)
.snapshotWatermarkTable("snapshotWatermarkTable")
.tables(DatabaseTablesProperty.builder()
.exclude(List.of("exclude"))
.include(List.of("include"))
.build())
.type("type")
// the properties below are optional
.columns(DatabaseColumnsProperty.builder()
.exclude(List.of("exclude"))
.include(List.of("include"))
.build())
.digest("digest")
.publicCertificate("publicCertificate")
.sslMode("sslMode")
.surrogateKeys(List.of("surrogateKeys"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDeliveryStream.DatabaseSourceConfigurationPropertystatic final classAn implementation forCfnDeliveryStream.DatabaseSourceConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe list of column patterns in source database endpoint for Firehose to read from.The list of database patterns in source database endpoint for Firehose to read from.The structure to configure the authentication methods for Firehose to connect to source database endpoint.The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.default StringThe endpoint of the database server.getPort()The port of the database.default StringThe fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.default StringThe mode to enable or disable SSL when Firehose connects to the database endpoint.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.The list of table patterns in source database endpoint for Firehose to read from.getType()The type of database engine.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDatabases
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.
Returns union: either
IResolvableorCfnDeliveryStream.DatabasesProperty- See Also:
-
getDatabaseSourceAuthenticationConfiguration
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.
Returns union: either
IResolvableorCfnDeliveryStream.DatabaseSourceAuthenticationConfigurationProperty- See Also:
-
getDatabaseSourceVpcConfiguration
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.
Returns union: either
IResolvableorCfnDeliveryStream.DatabaseSourceVPCConfigurationProperty- See Also:
-
getEndpoint
The endpoint of the database server.Amazon Data Firehose is in preview release and is subject to change.
- See Also:
-
getPort
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.
- See Also:
-
getSnapshotWatermarkTable
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.
- See Also:
-
getTables
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.
Returns union: either
IResolvableorCfnDeliveryStream.DatabaseTablesProperty- See Also:
-
getType
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.
- See Also:
-
getColumns
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.
Returns union: either
IResolvableorCfnDeliveryStream.DatabaseColumnsProperty- See Also:
-
getDigest
- See Also:
-
getPublicCertificate
- See Also:
-
getSslMode
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.
- See Also:
-
getSurrogateKeys
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.
- See Also:
-
builder
-