Package software.amazon.awscdk.services.dms

Interface CfnDataProvider.PostgreSqlSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataProvider.PostgreSqlSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDataProvider

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

Provides information that defines a PostgreSQL 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.*;
 PostgreSqlSettingsProperty postgreSqlSettingsProperty = PostgreSqlSettingsProperty.builder()
         .databaseName("databaseName")
         .port(123)
         .serverName("serverName")
         .sslMode("sslMode")
         // the properties below are optional
         .certificateArn("certificateArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataProvider.PostgreSqlSettingsProperty.Builder	builder()
default String	getCertificateArn()
String	getDatabaseName()	Database name for the endpoint.
Number	getPort()	Endpoint TCP port.
String	getServerName()	The host name of the endpoint database.
String	getSslMode()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

Database name for the endpoint.

See Also:

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

getPort

@Stability(Stable)
@NotNull
Number getPort()

Endpoint TCP port.

The default is 5432.

See Also:

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

getServerName

@Stability(Stable)
@NotNull
String getServerName()

The host name of the endpoint database.

For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters , in the Endpoint field.

See Also:

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

getSslMode

@Stability(Stable)
@NotNull
String getSslMode()

See Also:

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

getCertificateArn

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

See Also:

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

builder

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

Returns:

a CfnDataProvider.PostgreSqlSettingsProperty.Builder of CfnDataProvider.PostgreSqlSettingsProperty