ModifyEndpointRequest.Builder (AWS SDK for Java

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>, DatabaseMigrationRequest.Builder, SdkBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyEndpointRequest
```
public static interface ModifyEndpointRequest.Builder
extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ModifyEndpointRequest.Builder`	`certificateArn(String certificateArn)` The Amazon Resource Name (ARN) of the certificate used for SSL connection.
`ModifyEndpointRequest.Builder`	`databaseName(String databaseName)` The name of the endpoint database.
`default ModifyEndpointRequest.Builder`	`dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)` The settings in JSON format for the DMS transfer type of source endpoint.
`ModifyEndpointRequest.Builder`	`dmsTransferSettings(DmsTransferSettings dmsTransferSettings)` The settings in JSON format for the DMS transfer type of source endpoint.
`default ModifyEndpointRequest.Builder`	`dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)` Settings in JSON format for the target Amazon DynamoDB endpoint.
`ModifyEndpointRequest.Builder`	`dynamoDbSettings(DynamoDbSettings dynamoDbSettings)` Settings in JSON format for the target Amazon DynamoDB endpoint.
`default ModifyEndpointRequest.Builder`	`elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings)` Settings in JSON format for the target Elasticsearch endpoint.
`ModifyEndpointRequest.Builder`	`elasticsearchSettings(ElasticsearchSettings elasticsearchSettings)` Settings in JSON format for the target Elasticsearch endpoint.
`ModifyEndpointRequest.Builder`	`endpointArn(String endpointArn)` The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
`ModifyEndpointRequest.Builder`	`endpointIdentifier(String endpointIdentifier)` The database endpoint identifier.
`ModifyEndpointRequest.Builder`	`endpointType(ReplicationEndpointTypeValue endpointType)` The type of endpoint.
`ModifyEndpointRequest.Builder`	`endpointType(String endpointType)` The type of endpoint.
`ModifyEndpointRequest.Builder`	`engineName(String engineName)` The type of engine for the endpoint.
`ModifyEndpointRequest.Builder`	`externalTableDefinition(String externalTableDefinition)` The external table definition.
`ModifyEndpointRequest.Builder`	`extraConnectionAttributes(String extraConnectionAttributes)` Additional attributes associated with the connection.
`default ModifyEndpointRequest.Builder`	`kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)` Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
`ModifyEndpointRequest.Builder`	`kinesisSettings(KinesisSettings kinesisSettings)` Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
`default ModifyEndpointRequest.Builder`	`mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)` Settings in JSON format for the source MongoDB endpoint.
`ModifyEndpointRequest.Builder`	`mongoDbSettings(MongoDbSettings mongoDbSettings)` Settings in JSON format for the source MongoDB endpoint.
`ModifyEndpointRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)` Add an optional request override configuration.
`ModifyEndpointRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)` Add an optional request override configuration.
`ModifyEndpointRequest.Builder`	`password(String password)` The password to be used to login to the endpoint database.
`ModifyEndpointRequest.Builder`	`port(Integer port)` The port used by the endpoint database.
`default ModifyEndpointRequest.Builder`	`s3Settings(Consumer<S3Settings.Builder> s3Settings)` Settings in JSON format for the target Amazon S3 endpoint.
`ModifyEndpointRequest.Builder`	`s3Settings(S3Settings s3Settings)` Settings in JSON format for the target Amazon S3 endpoint.
`ModifyEndpointRequest.Builder`	`serverName(String serverName)` The name of the server where the endpoint database resides.
`ModifyEndpointRequest.Builder`	`serviceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
`ModifyEndpointRequest.Builder`	`sslMode(DmsSslModeValue sslMode)` The SSL mode to be used.
`ModifyEndpointRequest.Builder`	`sslMode(String sslMode)` The SSL mode to be used.
`ModifyEndpointRequest.Builder`	`username(String username)` The user name to be used to login to the endpoint database.

Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - endpointArn
```
ModifyEndpointRequest.Builder endpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpointIdentifier
```
ModifyEndpointRequest.Builder endpointIdentifier(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpointType
```
ModifyEndpointRequest.Builder endpointType(String endpointType)
```
    The type of endpoint.
    
    Parameters:
    
    endpointType - The type of endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReplicationEndpointTypeValue, ReplicationEndpointTypeValue
  - endpointType
```
ModifyEndpointRequest.Builder endpointType(ReplicationEndpointTypeValue endpointType)
```
    The type of endpoint.
    
    Parameters:
    
    endpointType - The type of endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReplicationEndpointTypeValue, ReplicationEndpointTypeValue
  - engineName
```
ModifyEndpointRequest.Builder engineName(String engineName)
```
    The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
    
    Parameters:
    
    engineName - The type of engine for the endpoint. 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - username
```
ModifyEndpointRequest.Builder username(String username)
```
    The user name to be used to login to the endpoint database.
    
    Parameters:
    
    username - The user name to be used to login to the endpoint database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - password
```
ModifyEndpointRequest.Builder password(String password)
```
    The password to be used to login to the endpoint database.
    
    Parameters:
    
    password - The password to be used to login to the endpoint database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serverName
```
ModifyEndpointRequest.Builder serverName(String serverName)
```
    The name of the server where the endpoint database resides.
    
    Parameters:
    
    serverName - The name of the server where the endpoint database resides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - port
```
ModifyEndpointRequest.Builder port(Integer port)
```
    The port used by the endpoint database.
    
    Parameters:
    
    port - The port used by the endpoint database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - databaseName
```
ModifyEndpointRequest.Builder databaseName(String databaseName)
```
    The name of the endpoint database.
    
    Parameters:
    
    databaseName - The name of the endpoint database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - extraConnectionAttributes
```
ModifyEndpointRequest.Builder extraConnectionAttributes(String extraConnectionAttributes)
```
    Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
    
    Parameters:
    
    extraConnectionAttributes - Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - certificateArn
```
ModifyEndpointRequest.Builder certificateArn(String certificateArn)
```
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    
    Parameters:
    
    certificateArn - The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sslMode
```
ModifyEndpointRequest.Builder sslMode(String sslMode)
```
    The SSL mode to be used.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Parameters:
    
    sslMode - The SSL mode to be used.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DmsSslModeValue, DmsSslModeValue
  - sslMode
```
ModifyEndpointRequest.Builder sslMode(DmsSslModeValue sslMode)
```
    The SSL mode to be used.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Parameters:
    
    sslMode - The SSL mode to be used.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DmsSslModeValue, DmsSslModeValue
  - serviceAccessRoleArn
```
ModifyEndpointRequest.Builder serviceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - externalTableDefinition
```
ModifyEndpointRequest.Builder externalTableDefinition(String externalTableDefinition)
```
    The external table definition.
    
    Parameters:
    
    externalTableDefinition - The external table definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dynamoDbSettings
```
ModifyEndpointRequest.Builder dynamoDbSettings(DynamoDbSettings dynamoDbSettings)
```
    Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
    
    Parameters:
    
    dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dynamoDbSettings
```
default ModifyEndpointRequest.Builder dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)
```
    Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
    This is a convenience that creates an instance of the DynamoDbSettings.Builder avoiding the need to create one manually via DynamoDbSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dynamoDbSettings(DynamoDbSettings).
    
    Parameters:
    
    dynamoDbSettings - a consumer that will call methods on DynamoDbSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    dynamoDbSettings(DynamoDbSettings)
  - s3Settings
```
ModifyEndpointRequest.Builder s3Settings(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - s3Settings
```
default ModifyEndpointRequest.Builder s3Settings(Consumer<S3Settings.Builder> 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.
    This is a convenience that creates an instance of the S3Settings.Builder avoiding the need to create one manually via S3Settings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Settings(S3Settings).
    
    Parameters:
    
    s3Settings - a consumer that will call methods on S3Settings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    s3Settings(S3Settings)
  - dmsTransferSettings
```
ModifyEndpointRequest.Builder dmsTransferSettings(DmsTransferSettings dmsTransferSettings)
```
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    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. Set to NONE (the default) or do not use to leave the files uncompressed.
    Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
    
    JSON syntax:
    
    { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    Parameters:
    dmsTransferSettings - The settings in JSON format for the DMS transfer type of source endpoint.
    
    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. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
    
    JSON syntax:
    
    { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dmsTransferSettings
```
default ModifyEndpointRequest.Builder dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)
```
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    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. Set to NONE (the default) or do not use to leave the files uncompressed.
    Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
    
    JSON syntax:
    
    { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    This is a convenience that creates an instance of the DmsTransferSettings.Builder avoiding the need to create one manually via DmsTransferSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dmsTransferSettings(DmsTransferSettings).
    Parameters:
    
    dmsTransferSettings - a consumer that will call methods on DmsTransferSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    dmsTransferSettings(DmsTransferSettings)
  - mongoDbSettings
```
ModifyEndpointRequest.Builder mongoDbSettings(MongoDbSettings mongoDbSettings)
```
    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    
    Parameters:
    
    mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mongoDbSettings
```
default ModifyEndpointRequest.Builder mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)
```
    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    This is a convenience that creates an instance of the MongoDbSettings.Builder avoiding the need to create one manually via MongoDbSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mongoDbSettings(MongoDbSettings).
    
    Parameters:
    
    mongoDbSettings - a consumer that will call methods on MongoDbSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    mongoDbSettings(MongoDbSettings)
  - kinesisSettings
```
ModifyEndpointRequest.Builder kinesisSettings(KinesisSettings kinesisSettings)
```
    Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
    
    Parameters:
    
    kinesisSettings - Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - kinesisSettings
```
default ModifyEndpointRequest.Builder kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)
```
    Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
    This is a convenience that creates an instance of the KinesisSettings.Builder avoiding the need to create one manually via KinesisSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisSettings(KinesisSettings).
    
    Parameters:
    
    kinesisSettings - a consumer that will call methods on KinesisSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    kinesisSettings(KinesisSettings)
  - elasticsearchSettings
```
ModifyEndpointRequest.Builder elasticsearchSettings(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 User Guide.
    
    Parameters:
    
    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 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - elasticsearchSettings
```
default ModifyEndpointRequest.Builder elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> 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 User Guide.
    This is a convenience that creates an instance of the ElasticsearchSettings.Builder avoiding the need to create one manually via ElasticsearchSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticsearchSettings(ElasticsearchSettings).
    
    Parameters:
    
    elasticsearchSettings - a consumer that will call methods on ElasticsearchSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    elasticsearchSettings(ElasticsearchSettings)
  - overrideConfiguration
```
ModifyEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    overrideConfiguration - The override configuration.
    
    Returns:
    
    This object for method chaining.
  - overrideConfiguration
```
ModifyEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
    
    Returns:
    
    This object for method chaining.

Interface ModifyEndpointRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

endpointArn

endpointIdentifier

endpointType

endpointType

engineName

username

password

serverName

port

databaseName

extraConnectionAttributes

certificateArn

sslMode

sslMode

serviceAccessRoleArn

externalTableDefinition

dynamoDbSettings

dynamoDbSettings

s3Settings

s3Settings

dmsTransferSettings

dmsTransferSettings

mongoDbSettings

mongoDbSettings

kinesisSettings

kinesisSettings

elasticsearchSettings

elasticsearchSettings

overrideConfiguration

overrideConfiguration