Endpoint (AWS SDK for Java

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>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Endpoint.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Endpoint.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`DynamoDbSettings`	`dynamoDbSettings()` The settings for the target DynamoDB database.
`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)`
`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()`
`KinesisSettings`	`kinesisSettings()` The settings for the Amazon Kinesis source endpoint.
`String`	`kmsKeyId()` The AWS KMS key identifier that is used to encrypt the content on the replication instance.
`MongoDbSettings`	`mongoDbSettings()` The settings for the MongoDB source endpoint.
`Integer`	`port()` The port value used to access the 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.
`Endpoint.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`username()` The user name used to connect to the endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - endpointIdentifier
```
public String endpointIdentifier()
```
    The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
    
    Returns:
    
    The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
  - endpointType
```
public ReplicationEndpointTypeValue endpointType()
```
    The type of endpoint.
    
    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.
    
    See Also:
    
    ReplicationEndpointTypeValue
  - endpointTypeAsString
```
public String endpointTypeAsString()
```
    The type of endpoint.
    
    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.
    
    See Also:
    
    ReplicationEndpointTypeValue
  - engineName
```
public 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, sybase, dynamodb, mongodb, and sqlserver.
    
    Returns:
    
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
  - engineDisplayName
```
public 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 String username()
```
    The user name used to connect to the endpoint.
    
    Returns:
    
    The user name used to connect to the endpoint.
  - serverName
```
public String serverName()
```
    The name of the server at the endpoint.
    
    Returns:
    
    The name of the server at the endpoint.
  - port
```
public Integer port()
```
    The port value used to access the endpoint.
    
    Returns:
    
    The port value used to access the endpoint.
  - databaseName
```
public String databaseName()
```
    The name of the database at the endpoint.
    
    Returns:
    
    The name of the database at the endpoint.
  - extraConnectionAttributes
```
public String extraConnectionAttributes()
```
    Additional connection attributes used to connect to the endpoint.
    
    Returns:
    
    Additional connection attributes used to connect to the endpoint.
  - status
```
public String status()
```
    The status of the endpoint.
    
    Returns:
    
    The status of the endpoint.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. 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:
    
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. 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 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 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 DmsSslModeValue sslMode()
```
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    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.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    See Also:
    
    DmsSslModeValue
  - sslModeAsString
```
public String sslModeAsString()
```
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    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.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    See Also:
    
    DmsSslModeValue
  - serviceAccessRoleArn
```
public 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 String externalTableDefinition()
```
    The external table definition.
    
    Returns:
    
    The external table definition.
  - externalId
```
public 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 DynamoDbSettings dynamoDbSettings()
```
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    
    Returns:
    
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
  - s3Settings
```
public 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 DmsTransferSettings dmsTransferSettings()
```
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes 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 attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes 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 attributes 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 attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
  - mongoDbSettings
```
public 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 KinesisSettings kinesisSettings()
```
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    
    Returns:
    
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
  - elasticsearchSettings
```
public 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.
  - toBuilder
```
public Endpoint.Builder 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 interface ToCopyableBuilder<Endpoint.Builder,Endpoint>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Endpoint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Endpoint.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Endpoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

endpointIdentifier

endpointType

endpointTypeAsString

engineName

engineDisplayName

username

serverName

port

databaseName

extraConnectionAttributes

status

kmsKeyId

endpointArn

certificateArn

sslMode

sslModeAsString

serviceAccessRoleArn

externalTableDefinition

externalId

dynamoDbSettings

s3Settings

dmsTransferSettings

mongoDbSettings

kinesisSettings

elasticsearchSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields