Package software.amazon.awscdk.services.dms

Interface CfnDataProvider.DocDbSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataProvider.DocDbSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDataProvider

@Stability(Stable)
public static interface CfnDataProvider.DocDbSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that defines a DocumentDB endpoint.

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.dms.*;
 DocDbSettingsProperty docDbSettingsProperty = DocDbSettingsProperty.builder()
         .databaseName("databaseName")
         .port(123)
         .serverName("serverName")
         // the properties below are optional
         .certificateArn("certificateArn")
         .sslMode("sslMode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataProvider.DocDbSettingsProperty.Builder	A builder for CfnDataProvider.DocDbSettingsProperty
static final class	CfnDataProvider.DocDbSettingsProperty.Jsii$Proxy	An implementation for CfnDataProvider.DocDbSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataProvider.DocDbSettingsProperty.Builder	builder()
default String	getCertificateArn()
String	getDatabaseName()	The database name on the DocumentDB source endpoint.
Number	getPort()	The port value for the DocumentDB source endpoint.
String	getServerName()	The name of the server on the DocumentDB source endpoint.
default String	getSslMode()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

The database name on the DocumentDB source endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-databasename

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port value for the DocumentDB source endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-port

getServerName

@Stability(Stable)
@NotNull
String getServerName()

The name of the server on the DocumentDB source endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-servername

getCertificateArn

@Stability(Stable)
@Nullable
default String getCertificateArn()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-certificatearn

getSslMode

@Stability(Stable)
@Nullable
default String getSslMode()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-sslmode

builder

@Stability(Stable)
static CfnDataProvider.DocDbSettingsProperty.Builder builder()

Returns:

a CfnDataProvider.DocDbSettingsProperty.Builder of CfnDataProvider.DocDbSettingsProperty