Class Endpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Endpoint.Builder,
Endpoint>
Describes an endpoint of a database instance in response to operations such as the following:
-
CreateEndpoint
-
DescribeEndpoint
-
ModifyEndpoint
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Endpoint.Builder
builder()
final String
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.final String
The name of the database at the endpoint.final DmsTransferSettings
The settings for the DMS Transfer type source.final DocDbSettings
Returns the value of the DocDbSettings property for this object.final DynamoDbSettings
The settings for the DynamoDB target endpoint.final ElasticsearchSettings
The settings for the OpenSearch source endpoint.final String
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.final String
The database endpoint identifier.The type of endpoint.final String
The type of endpoint.final String
The expanded name for the engine name.final String
The database engine name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Value returned by a call to CreateEndpoint that can be used for cross-account validation.final String
The external table definition.final String
Additional connection attributes used to connect to the endpoint.final GcpMySQLSettings
Settings in JSON format for the source GCP MySQL endpoint.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final IBMDb2Settings
The settings for the IBM Db2 LUW source endpoint.final KafkaSettings
The settings for the Apache Kafka target endpoint.final KinesisSettings
The settings for the Amazon Kinesis target endpoint.final String
kmsKeyId()
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.The settings for the Microsoft SQL Server source and target endpoint.final MongoDbSettings
The settings for the MongoDB source endpoint.final MySQLSettings
The settings for the MySQL source and target endpoint.final NeptuneSettings
The settings for the Amazon Neptune target endpoint.final OracleSettings
The settings for the Oracle source and target endpoint.final Integer
port()
The port value used to access the endpoint.final PostgreSQLSettings
The settings for the PostgreSQL source and target endpoint.final RedisSettings
The settings for the Redis target endpoint.final RedshiftSettings
Settings for the Amazon Redshift endpoint.final S3Settings
The settings for the S3 target endpoint.static Class
<? extends Endpoint.Builder> final String
The name of the server at the endpoint.final String
The Amazon Resource Name (ARN) used by the service to access the IAM role.final DmsSslModeValue
sslMode()
The SSL mode used to connect to the endpoint.final String
The SSL mode used to connect to the endpoint.final String
status()
The status of the endpoint.final SybaseSettings
The settings for the SAP ASE source and target endpoint.final TimestreamSettings
The settings for the Amazon Timestream target endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
username()
The user name used to connect to the endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The type of endpoint. Valid values are
source
andtarget
.If the service returns an enum value that is not available in the current SDK version,
endpointType
will returnReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The type of endpoint. Valid values are
source
andtarget
. - See Also:
-
endpointTypeAsString
The type of endpoint. Valid values are
source
andtarget
.If the service returns an enum value that is not available in the current SDK version,
endpointType
will returnReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The type of endpoint. Valid values are
source
andtarget
. - See Also:
-
engineName
The database engine name. Valid values, depending on the EndpointType, include
"mysql"
,"oracle"
,"postgres"
,"mariadb"
,"aurora"
,"aurora-postgresql"
,"redshift"
,"redshift-serverless"
,"s3"
,"db2"
,"db2-zos"
,"azuredb"
,"sybase"
,"dynamodb"
,"mongodb"
,"kinesis"
,"kafka"
,"elasticsearch"
,"documentdb"
,"sqlserver"
,"neptune"
, and"babelfish"
.- Returns:
- The database engine name. Valid values, depending on the EndpointType, include
"mysql"
,"oracle"
,"postgres"
,"mariadb"
,"aurora"
,"aurora-postgresql"
,"redshift"
,"redshift-serverless"
,"s3"
,"db2"
,"db2-zos"
,"azuredb"
,"sybase"
,"dynamodb"
,"mongodb"
,"kinesis"
,"kafka"
,"elasticsearch"
,"documentdb"
,"sqlserver"
,"neptune"
, and"babelfish"
.
-
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
The user name used to connect to the endpoint.
- Returns:
- The user name used to connect to the endpoint.
-
serverName
The name of the server at the endpoint.
- Returns:
- The name of the server at the endpoint.
-
port
The port value used to access the endpoint.
- Returns:
- The port value used to access the endpoint.
-
databaseName
The name of the database at the endpoint.
- Returns:
- The name of the database at the endpoint.
-
extraConnectionAttributes
Additional connection attributes used to connect to the endpoint.
- Returns:
- Additional connection attributes used to connect to the endpoint.
-
status
The status of the endpoint.
- Returns:
- The status of the endpoint.
-
kmsKeyId
An 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 DMS uses your default encryption key.KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
- Returns:
- An 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 DMS uses your default encryption key.KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
-
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
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
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 returnDmsSslModeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsslModeAsString()
.- Returns:
- The SSL mode used to connect to the endpoint. The default value is
none
. - See Also:
-
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 returnDmsSslModeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsslModeAsString()
.- Returns:
- The SSL mode used to connect to the endpoint. The default value is
none
. - See Also:
-
serviceAccessRoleArn
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.- Returns:
- The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.
-
externalTableDefinition
The external table definition.
- Returns:
- The external table definition.
-
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
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
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
The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
- Returns:
- The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
-
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
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
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
The settings for the OpenSearch source endpoint. For more information, see the
ElasticsearchSettings
structure.- Returns:
- The settings for the OpenSearch source endpoint. For more information, see the
ElasticsearchSettings
structure.
-
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
Settings for the Amazon Redshift endpoint.
- Returns:
- Settings for the Amazon Redshift endpoint.
-
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
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
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
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
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
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
Returns the value of the DocDbSettings property for this object.- Returns:
- The value of the DocDbSettings property for this object.
-
redisSettings
The settings for the Redis target endpoint. For more information, see the
RedisSettings
structure.- Returns:
- The settings for the Redis target endpoint. For more information, see the
RedisSettings
structure.
-
gcpMySQLSettings
Settings in JSON format for the source GCP MySQL endpoint.
- Returns:
- Settings in JSON format for the source GCP MySQL endpoint.
-
timestreamSettings
The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.- Returns:
- The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Endpoint.Builder,
Endpoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-