CreateEndpointRequest (AWS Java SDK :: Services :: AWS Database Migration Service 2.16.60 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
    - - software.amazon.awssdk.services.databasemigration.model.CreateEndpointRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEndpointRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEndpointRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateEndpointRequest.Builder`	`builder()`
`String`	`certificateArn()` The Amazon Resource Name (ARN) for the certificate.
`String`	`databaseName()` The name of the endpoint database.
`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()` Settings in JSON format for the target Amazon DynamoDB endpoint.
`ElasticsearchSettings`	`elasticsearchSettings()` Settings in JSON format for the target Elasticsearch endpoint.
`String`	`endpointIdentifier()` The database endpoint identifier.
`ReplicationEndpointTypeValue`	`endpointType()` The type of endpoint.
`String`	`endpointTypeAsString()` The type of endpoint.
`String`	`engineName()` The type of engine for the endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`externalTableDefinition()` The external table definition.
`String`	`extraConnectionAttributes()` Additional attributes associated with the connection.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`IBMDb2Settings`	`ibmDb2Settings()` Settings in JSON format for the source IBM Db2 LUW endpoint.
`KafkaSettings`	`kafkaSettings()` Settings in JSON format for the target Apache Kafka endpoint.
`KinesisSettings`	`kinesisSettings()` Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
`String`	`kmsKeyId()` An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
`MicrosoftSQLServerSettings`	`microsoftSQLServerSettings()` Settings in JSON format for the source and target Microsoft SQL Server endpoint.
`MongoDbSettings`	`mongoDbSettings()` Settings in JSON format for the source MongoDB endpoint.
`MySQLSettings`	`mySQLSettings()` Settings in JSON format for the source and target MySQL endpoint.
`NeptuneSettings`	`neptuneSettings()` Settings in JSON format for the target Amazon Neptune endpoint.
`OracleSettings`	`oracleSettings()` Settings in JSON format for the source and target Oracle endpoint.
`String`	`password()` The password to be used to log in to the endpoint database.
`Integer`	`port()` The port used by the endpoint database.
`PostgreSQLSettings`	`postgreSQLSettings()` Settings in JSON format for the source and target PostgreSQL endpoint.
`RedshiftSettings`	`redshiftSettings()` Returns the value of the RedshiftSettings property for this object.
`String`	`resourceIdentifier()` A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
`S3Settings`	`s3Settings()` Settings in JSON format for the target Amazon S3 endpoint.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateEndpointRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverName()` The name of the server where the endpoint database resides.
`String`	`serviceAccessRoleArn()` The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
`DmsSslModeValue`	`sslMode()` The Secure Sockets Layer (SSL) mode to use for the SSL connection.
`String`	`sslModeAsString()` The Secure Sockets Layer (SSL) mode to use for the SSL connection.
`SybaseSettings`	`sybaseSettings()` Settings in JSON format for the source and target SAP ASE endpoint.
`List<Tag>`	`tags()` One or more tags to be assigned to the endpoint.
`CreateEndpointRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`username()` The user name to be used to log in to the endpoint database.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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 type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune".
    
    Returns:
    
    The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune".
  - username
```
public final String username()
```
    The user name to be used to log in to the endpoint database.
    
    Returns:
    
    The user name to be used to log in to the endpoint database.
  - password
```
public final String password()
```
    The password to be used to log in to the endpoint database.
    
    Returns:
    
    The password to be used to log in to the endpoint database.
  - serverName
```
public final String serverName()
```
    The name of the server where the endpoint database resides.
    
    Returns:
    
    The name of the server where the endpoint database resides.
  - port
```
public final Integer port()
```
    The port used by the endpoint database.
    
    Returns:
    
    The port used by the endpoint database.
  - databaseName
```
public final String databaseName()
```
    The name of the endpoint database.
    
    Returns:
    
    The name of the endpoint database.
  - extraConnectionAttributes
```
public final String extraConnectionAttributes()
```
    Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide.
  - 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.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    One or more tags to be assigned to the endpoint.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    One or more tags to be assigned to the endpoint.
  - certificateArn
```
public final String certificateArn()
```
    The Amazon Resource Name (ARN) for the certificate.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the certificate.
  - sslMode
```
public final DmsSslModeValue sslMode()
```
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default 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 Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
    
    See Also:
    
    DmsSslModeValue
  - sslModeAsString
```
public final String sslModeAsString()
```
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default 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 Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
    
    See Also:
    
    DmsSslModeValue
  - serviceAccessRoleArn
```
public final String serviceAccessRoleArn()
```
    The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
  - externalTableDefinition
```
public final String externalTableDefinition()
```
    The external table definition.
    
    Returns:
    
    The external table definition.
  - dynamoDbSettings
```
public final DynamoDbSettings dynamoDbSettings()
```
    Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
  - s3Settings
```
public final S3Settings s3Settings()
```
    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
  - 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()
```
    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
  - kinesisSettings
```
public final KinesisSettings kinesisSettings()
```
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
  - kafkaSettings
```
public final KafkaSettings kafkaSettings()
```
    Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
  - elasticsearchSettings
```
public final ElasticsearchSettings elasticsearchSettings()
```
    Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.
  - neptuneSettings
```
public final NeptuneSettings neptuneSettings()
```
    Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
  - redshiftSettings
```
public final RedshiftSettings redshiftSettings()
```
    Returns the value of the RedshiftSettings property for this object.
    
    Returns:
    
    The value of the RedshiftSettings property for this object.
  - postgreSQLSettings
```
public final PostgreSQLSettings postgreSQLSettings()
```
    Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.
  - mySQLSettings
```
public final MySQLSettings mySQLSettings()
```
    Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.
  - oracleSettings
```
public final OracleSettings oracleSettings()
```
    Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.
  - sybaseSettings
```
public final SybaseSettings sybaseSettings()
```
    Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.
  - microsoftSQLServerSettings
```
public final MicrosoftSQLServerSettings microsoftSQLServerSettings()
```
    Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.
  - ibmDb2Settings
```
public final IBMDb2Settings ibmDb2Settings()
```
    Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide.
  - resourceIdentifier
```
public final String resourceIdentifier()
```
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn.
    
    Returns:
    
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn.
  - 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 CreateEndpointRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>
    
    Specified by:
    
    toBuilder in class DatabaseMigrationRequest
  - builder
```
public static CreateEndpointRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateEndpointRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateEndpointRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

endpointIdentifier

endpointType

endpointTypeAsString

engineName

username

password

serverName

port

databaseName

extraConnectionAttributes

kmsKeyId

hasTags

tags

certificateArn

sslMode

sslModeAsString

serviceAccessRoleArn

externalTableDefinition

dynamoDbSettings

s3Settings

dmsTransferSettings

mongoDbSettings

kinesisSettings

kafkaSettings

elasticsearchSettings

neptuneSettings

redshiftSettings

postgreSQLSettings

mySQLSettings

oracleSettings

sybaseSettings

microsoftSQLServerSettings

ibmDb2Settings

resourceIdentifier

docDbSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields