software.amazon.awssdk.services.databasemigration.model

Class Endpoint

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.Endpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Endpoint.Builder,Endpoint>

@Generated(value="software.amazon.awssdk:codegen")
public final class Endpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Endpoint.Builder,Endpoint>

Describes an endpoint of a database instance in response to operations such as the following:

• CreateEndpoint

• DescribeEndpoint

• DescribeEndpointTypes

• ModifyEndpoint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Endpoint.Builder

Method Summary

Modifier and Type	Method and Description
static Endpoint.Builder	builder()
String	certificateArn() The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
String	databaseName() The name of the database at the endpoint.
DmsTransferSettings	dmsTransferSettings() The settings in JSON format for the DMS transfer type of source endpoint.
DocDbSettings	docDbSettings() Returns the value of the DocDbSettings property for this object.
DynamoDbSettings	dynamoDbSettings() The settings for the DynamoDB target endpoint.
ElasticsearchSettings	elasticsearchSettings() The settings for the Elasticsearch source endpoint.
String	endpointArn() The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String	endpointIdentifier() The database endpoint identifier.
ReplicationEndpointTypeValue	endpointType() The type of endpoint.
String	endpointTypeAsString() The type of endpoint.
String	engineDisplayName() The expanded name for the engine name.
String	engineName() The database engine name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() Value returned by a call to CreateEndpoint that can be used for cross-account validation.
String	externalTableDefinition() The external table definition.
String	extraConnectionAttributes() Additional connection attributes used to connect to the endpoint.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IBMDb2Settings	ibmDb2Settings() The settings for the IBM Db2 LUW source endpoint.
KafkaSettings	kafkaSettings() The settings for the Apache Kafka target endpoint.
KinesisSettings	kinesisSettings() The settings for the Amazon Kinesis target endpoint.
String	kmsKeyId() An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
MicrosoftSQLServerSettings	microsoftSQLServerSettings() The settings for the Microsoft SQL Server source and target endpoint.
MongoDbSettings	mongoDbSettings() The settings for the MongoDB source endpoint.
MySQLSettings	mySQLSettings() The settings for the MySQL source and target endpoint.
NeptuneSettings	neptuneSettings() The settings for the Amazon Neptune target endpoint.
OracleSettings	oracleSettings() The settings for the Oracle source and target endpoint.
Integer	port() The port value used to access the endpoint.
PostgreSQLSettings	postgreSQLSettings() The settings for the PostgreSQL source and target endpoint.
RedshiftSettings	redshiftSettings() Settings for the Amazon Redshift endpoint.
S3Settings	s3Settings() The settings for the S3 target endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends Endpoint.Builder>	serializableBuilderClass()
String	serverName() The name of the server at the endpoint.
String	serviceAccessRoleArn() The Amazon Resource Name (ARN) used by the service access IAM role.
DmsSslModeValue	sslMode() The SSL mode used to connect to the endpoint.
String	sslModeAsString() The SSL mode used to connect to the endpoint.
String	status() The status of the endpoint.
SybaseSettings	sybaseSettings() The settings for the SAP ASE source and target endpoint.
Endpoint.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	username() The user name used to connect to the endpoint.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

endpointIdentifier

public final String endpointIdentifier()

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

Returns:

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

endpointType

public final ReplicationEndpointTypeValue endpointType()

The type of endpoint. Valid values are source and target.

If the service returns an enum value that is not available in the current SDK version, endpointType will return ReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

Returns:

The type of endpoint. Valid values are source and target.

See Also:

ReplicationEndpointTypeValue

endpointTypeAsString

public final String endpointTypeAsString()

The type of endpoint. Valid values are source and target.

If the service returns an enum value that is not available in the current SDK version, endpointType will return ReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

Returns:

The type of endpoint. Valid values are source and target.

See Also:

ReplicationEndpointTypeValue

engineName

public final String engineName()

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

Returns:

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

engineDisplayName

public final String engineDisplayName()

The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

Returns:

The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

username

public final String username()

The user name used to connect to the endpoint.

Returns:

The user name used to connect to the endpoint.

serverName

public final String serverName()

The name of the server at the endpoint.

Returns:

The name of the server at the endpoint.

port

public final Integer port()

The port value used to access the endpoint.

Returns:

The port value used to access the endpoint.

databaseName

public final String databaseName()

The name of the database at the endpoint.

Returns:

The name of the database at the endpoint.

extraConnectionAttributes

public final String extraConnectionAttributes()

Additional connection attributes used to connect to the endpoint.

Returns:

Additional connection attributes used to connect to the endpoint.

status

public final String status()

The status of the endpoint.

Returns:

The status of the endpoint.

kmsKeyId

public final String kmsKeyId()

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Returns:

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

endpointArn

public final String endpointArn()

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Returns:

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

certificateArn

public final String certificateArn()

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

Returns:

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

sslMode

public final DmsSslModeValue sslMode()

The SSL mode used to connect to the endpoint. The default value is none.

If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

Returns:

The SSL mode used to connect to the endpoint. The default value is none.

See Also:

DmsSslModeValue

sslModeAsString

public final String sslModeAsString()

The SSL mode used to connect to the endpoint. The default value is none.

If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

Returns:

The SSL mode used to connect to the endpoint. The default value is none.

See Also:

DmsSslModeValue

serviceAccessRoleArn

public final String serviceAccessRoleArn()

The Amazon Resource Name (ARN) used by the service access IAM role.

Returns:

The Amazon Resource Name (ARN) used by the service access IAM role.

externalTableDefinition

public final String externalTableDefinition()

The external table definition.

Returns:

The external table definition.

externalId

public final String externalId()

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

Returns:

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

dynamoDbSettings

public final DynamoDbSettings dynamoDbSettings()

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

Returns:

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

s3Settings

public final S3Settings s3Settings()

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

Returns:

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

dmsTransferSettings

public final DmsTransferSettings dmsTransferSettings()

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

• ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

• BucketName - The name of the S3 bucket to use.

• CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

Returns:

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

• ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

• BucketName - The name of the S3 bucket to use.

• CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

mongoDbSettings

public final MongoDbSettings mongoDbSettings()

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

Returns:

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

kinesisSettings

public final KinesisSettings kinesisSettings()

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

Returns:

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

kafkaSettings

public final KafkaSettings kafkaSettings()

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

Returns:

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

elasticsearchSettings

public final ElasticsearchSettings elasticsearchSettings()

The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

Returns:

The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

neptuneSettings

public final NeptuneSettings neptuneSettings()

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

Returns:

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

redshiftSettings

public final RedshiftSettings redshiftSettings()

Settings for the Amazon Redshift endpoint.

Returns:

Settings for the Amazon Redshift endpoint.

postgreSQLSettings

public final PostgreSQLSettings postgreSQLSettings()

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

Returns:

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

mySQLSettings

public final MySQLSettings mySQLSettings()

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

Returns:

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

oracleSettings

public final OracleSettings oracleSettings()

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

Returns:

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

sybaseSettings

public final SybaseSettings sybaseSettings()

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

Returns:

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

microsoftSQLServerSettings

public final MicrosoftSQLServerSettings microsoftSQLServerSettings()

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

Returns:

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

ibmDb2Settings

public final IBMDb2Settings ibmDb2Settings()

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

Returns:

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

docDbSettings

public final DocDbSettings docDbSettings()

Returns the value of the DocDbSettings property for this object.

Returns:

The value of the DocDbSettings property for this object.

toBuilder

public Endpoint.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Endpoint.Builder,Endpoint>

builder

public static Endpoint.Builder builder()

serializableBuilderClass

public static Class<? extends Endpoint.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo