Package software.amazon.awssdk.services.databasemigration.model

Class ModifyEndpointRequest

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.ModifyEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyEndpointRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>

  • Method Details

    • 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.

    • 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:

    • 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:

    • 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", "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", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish" .

    • username

      public final String username()

      The user name to be used to login to the endpoint database.

      Returns:
      The user name to be used to login to the endpoint database.

    • password

      public final String password()

      The password to be used to login to the endpoint database.

      Returns:
      The password to be used to login 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. For a MySQL source or target endpoint, do not specify DatabaseName.

      Returns:
      The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

    • extraConnectionAttributes

      public final String extraConnectionAttributes()

      Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

      Returns:
      Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

    • certificateArn

      public final String certificateArn()

      The Amazon Resource Name (ARN) of the certificate used for SSL connection.

      Returns:
      The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    • 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:

    • 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:

    • serviceAccessRoleArn

      public final String serviceAccessRoleArn()

      The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

      Returns:
      The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

    • 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 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 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 DMS in the 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 DMS in the Database Migration Service User Guide.

    • dmsTransferSettings

      public final DmsTransferSettings dmsTransferSettings()

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

      Attributes include the following:

      • serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

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

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

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

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

      Attributes include the following:

      • serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

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

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

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

    • mongoDbSettings

      public final MongoDbSettings mongoDbSettings()

      Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

      Returns:
      Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the 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 object mapping to migrate data to a Kinesis data stream in the 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 object mapping to migrate data to a Kinesis data stream in the 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 object mapping to migrate data to a Kafka topic in the 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 object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

    • elasticsearchSettings

      public final ElasticsearchSettings elasticsearchSettings()

      Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

      Returns:
      Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the 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 graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the 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 graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the 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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the 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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the 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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the 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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the 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 DMS and Extra connection attributes when using Oracle as a target for DMS in the 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 DMS and Extra connection attributes when using Oracle as a target for DMS in the 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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the 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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the 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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the 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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the 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 DMS in the 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 DMS in the Database Migration Service User Guide.

    • docDbSettings

      public final DocDbSettings docDbSettings()

      Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

      Returns:
      Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

    • redisSettings

      public final RedisSettings redisSettings()

      Settings in JSON format for the Redis target endpoint.

      Returns:
      Settings in JSON format for the Redis target endpoint.

    • exactSettings

      public final Boolean exactSettings()

      If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

      • It replaces any endpoint settings that already exist with new values, for settings with the same names.

      • It creates new endpoint settings that you specify in the call, for settings with different names.

      For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

      However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

      Returns:
      If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

      • It replaces any endpoint settings that already exist with new values, for settings with the same names.

      • It creates new endpoint settings that you specify in the call, for settings with different names.

      For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

      However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

    • gcpMySQLSettings

      public final GcpMySQLSettings gcpMySQLSettings()

      Settings in JSON format for the source GCP MySQL endpoint.

      Returns:
      Settings in JSON format for the source GCP MySQL endpoint.

    • timestreamSettings

      public final TimestreamSettings timestreamSettings()

      Settings in JSON format for the target Amazon Timestream endpoint.

      Returns:
      Settings in JSON format for the target Amazon Timestream endpoint.

    • toBuilder

      public ModifyEndpointRequest.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<ModifyEndpointRequest.Builder,ModifyEndpointRequest>
      Specified by:
      toBuilder in class DatabaseMigrationRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyEndpointRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final 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.