Interface CreateEndpointRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateEndpointRequest.Builder,
,CreateEndpointRequest> DatabaseMigrationRequest.Builder
,SdkBuilder<CreateEndpointRequest.Builder,
,CreateEndpointRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEndpointRequest
-
Method Summary
Modifier and TypeMethodDescriptioncertificateArn
(String certificateArn) The Amazon Resource Name (ARN) for the certificate.databaseName
(String databaseName) The name of the endpoint database.default CreateEndpointRequest.Builder
dmsTransferSettings
(Consumer<DmsTransferSettings.Builder> dmsTransferSettings) The settings in JSON format for the DMS transfer type of source endpoint.dmsTransferSettings
(DmsTransferSettings dmsTransferSettings) The settings in JSON format for the DMS transfer type of source endpoint.default CreateEndpointRequest.Builder
docDbSettings
(Consumer<DocDbSettings.Builder> docDbSettings) Sets the value of the DocDbSettings property for this object.docDbSettings
(DocDbSettings docDbSettings) Sets the value of the DocDbSettings property for this object.default CreateEndpointRequest.Builder
dynamoDbSettings
(Consumer<DynamoDbSettings.Builder> dynamoDbSettings) Settings in JSON format for the target Amazon DynamoDB endpoint.dynamoDbSettings
(DynamoDbSettings dynamoDbSettings) Settings in JSON format for the target Amazon DynamoDB endpoint.default CreateEndpointRequest.Builder
elasticsearchSettings
(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings) Settings in JSON format for the target OpenSearch endpoint.elasticsearchSettings
(ElasticsearchSettings elasticsearchSettings) Settings in JSON format for the target OpenSearch endpoint.endpointIdentifier
(String endpointIdentifier) The database endpoint identifier.endpointType
(String endpointType) The type of endpoint.endpointType
(ReplicationEndpointTypeValue endpointType) The type of endpoint.engineName
(String engineName) The type of engine for the endpoint.externalTableDefinition
(String externalTableDefinition) The external table definition.extraConnectionAttributes
(String extraConnectionAttributes) Additional attributes associated with the connection.default CreateEndpointRequest.Builder
gcpMySQLSettings
(Consumer<GcpMySQLSettings.Builder> gcpMySQLSettings) Settings in JSON format for the source GCP MySQL endpoint.gcpMySQLSettings
(GcpMySQLSettings gcpMySQLSettings) Settings in JSON format for the source GCP MySQL endpoint.default CreateEndpointRequest.Builder
ibmDb2Settings
(Consumer<IBMDb2Settings.Builder> ibmDb2Settings) Settings in JSON format for the source IBM Db2 LUW endpoint.ibmDb2Settings
(IBMDb2Settings ibmDb2Settings) Settings in JSON format for the source IBM Db2 LUW endpoint.default CreateEndpointRequest.Builder
kafkaSettings
(Consumer<KafkaSettings.Builder> kafkaSettings) Settings in JSON format for the target Apache Kafka endpoint.kafkaSettings
(KafkaSettings kafkaSettings) Settings in JSON format for the target Apache Kafka endpoint.default CreateEndpointRequest.Builder
kinesisSettings
(Consumer<KinesisSettings.Builder> kinesisSettings) Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.kinesisSettings
(KinesisSettings kinesisSettings) Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.An KMS key identifier that is used to encrypt the connection parameters for the endpoint.default CreateEndpointRequest.Builder
microsoftSQLServerSettings
(Consumer<MicrosoftSQLServerSettings.Builder> microsoftSQLServerSettings) Settings in JSON format for the source and target Microsoft SQL Server endpoint.microsoftSQLServerSettings
(MicrosoftSQLServerSettings microsoftSQLServerSettings) Settings in JSON format for the source and target Microsoft SQL Server endpoint.default CreateEndpointRequest.Builder
mongoDbSettings
(Consumer<MongoDbSettings.Builder> mongoDbSettings) Settings in JSON format for the source MongoDB endpoint.mongoDbSettings
(MongoDbSettings mongoDbSettings) Settings in JSON format for the source MongoDB endpoint.default CreateEndpointRequest.Builder
mySQLSettings
(Consumer<MySQLSettings.Builder> mySQLSettings) Settings in JSON format for the source and target MySQL endpoint.mySQLSettings
(MySQLSettings mySQLSettings) Settings in JSON format for the source and target MySQL endpoint.default CreateEndpointRequest.Builder
neptuneSettings
(Consumer<NeptuneSettings.Builder> neptuneSettings) Settings in JSON format for the target Amazon Neptune endpoint.neptuneSettings
(NeptuneSettings neptuneSettings) Settings in JSON format for the target Amazon Neptune endpoint.default CreateEndpointRequest.Builder
oracleSettings
(Consumer<OracleSettings.Builder> oracleSettings) Settings in JSON format for the source and target Oracle endpoint.oracleSettings
(OracleSettings oracleSettings) Settings in JSON format for the source and target Oracle endpoint.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The password to be used to log in to the endpoint database.The port used by the endpoint database.default CreateEndpointRequest.Builder
postgreSQLSettings
(Consumer<PostgreSQLSettings.Builder> postgreSQLSettings) Settings in JSON format for the source and target PostgreSQL endpoint.postgreSQLSettings
(PostgreSQLSettings postgreSQLSettings) Settings in JSON format for the source and target PostgreSQL endpoint.default CreateEndpointRequest.Builder
redisSettings
(Consumer<RedisSettings.Builder> redisSettings) Settings in JSON format for the target Redis endpoint.redisSettings
(RedisSettings redisSettings) Settings in JSON format for the target Redis endpoint.default CreateEndpointRequest.Builder
redshiftSettings
(Consumer<RedshiftSettings.Builder> redshiftSettings) Sets the value of the RedshiftSettings property for this object.redshiftSettings
(RedshiftSettings redshiftSettings) Sets the value of the RedshiftSettings property for this object.resourceIdentifier
(String resourceIdentifier) A friendly name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
object.default CreateEndpointRequest.Builder
s3Settings
(Consumer<S3Settings.Builder> s3Settings) Settings in JSON format for the target Amazon S3 endpoint.s3Settings
(S3Settings s3Settings) Settings in JSON format for the target Amazon S3 endpoint.serverName
(String serverName) The name of the server where the endpoint database resides.serviceAccessRoleArn
(String serviceAccessRoleArn) The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.The Secure Sockets Layer (SSL) mode to use for the SSL connection.sslMode
(DmsSslModeValue sslMode) The Secure Sockets Layer (SSL) mode to use for the SSL connection.default CreateEndpointRequest.Builder
sybaseSettings
(Consumer<SybaseSettings.Builder> sybaseSettings) Settings in JSON format for the source and target SAP ASE endpoint.sybaseSettings
(SybaseSettings sybaseSettings) Settings in JSON format for the source and target SAP ASE endpoint.tags
(Collection<Tag> tags) One or more tags to be assigned to the endpoint.tags
(Consumer<Tag.Builder>... tags) One or more tags to be assigned to the endpoint.One or more tags to be assigned to the endpoint.default CreateEndpointRequest.Builder
timestreamSettings
(Consumer<TimestreamSettings.Builder> timestreamSettings) Settings in JSON format for the target Amazon Timestream endpoint.timestreamSettings
(TimestreamSettings timestreamSettings) Settings in JSON format for the target Amazon Timestream endpoint.The user name to be used to log in to the endpoint database.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
endpointType
The type of endpoint. Valid values are
source
andtarget
.- Parameters:
endpointType
- The type of endpoint. Valid values aresource
andtarget
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
endpointType
The type of endpoint. Valid values are
source
andtarget
.- Parameters:
endpointType
- The type of endpoint. Valid values aresource
andtarget
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
engineName
The type of engine for the endpoint. Valid values, depending on the
EndpointType
value, include"mysql"
,"oracle"
,"postgres"
,"mariadb"
,"aurora"
,"aurora-postgresql"
,"opensearch"
,"redshift"
,"s3"
,"db2"
,"db2-zos"
,"azuredb"
,"sybase"
,"dynamodb"
,"mongodb"
,"kinesis"
,"kafka"
,"elasticsearch"
,"docdb"
,"sqlserver"
,"neptune"
, and"babelfish"
.- Parameters:
engineName
- The type of engine for the endpoint. Valid values, depending on theEndpointType
value, include"mysql"
,"oracle"
,"postgres"
,"mariadb"
,"aurora"
,"aurora-postgresql"
,"opensearch"
,"redshift"
,"s3"
,"db2"
,"db2-zos"
,"azuredb"
,"sybase"
,"dynamodb"
,"mongodb"
,"kinesis"
,"kafka"
,"elasticsearch"
,"docdb"
,"sqlserver"
,"neptune"
, and"babelfish"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
The user name to be used to log in to the endpoint database.
- Parameters:
username
- The user name to be used to log in to the endpoint database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
password
The password to be used to log in to the endpoint database.
- Parameters:
password
- The password to be used to log in to the endpoint database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and
targetDbType
.- Parameters:
databaseName
- The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting andtargetDbType
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 DMS Endpoints in the Database Migration Service User Guide.
- Parameters:
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 DMS Endpoints in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the endpoint.
- Parameters:
tags
- One or more tags to be assigned to the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the endpoint.
- Parameters:
tags
- One or more tags to be assigned to the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the endpoint.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
certificateArn
The Amazon Resource Name (ARN) for the certificate.
- Parameters:
certificateArn
- The Amazon Resource Name (ARN) for the certificate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sslMode
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
none
- Parameters:
sslMode
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default isnone
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sslMode
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
none
- Parameters:
sslMode
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default isnone
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceAccessRoleArn
The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the
iam:PassRole
action.- Parameters:
serviceAccessRoleArn
- The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow theiam:PassRole
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
dynamoDbSettings
default CreateEndpointRequest.Builder dynamoDbSettings(Consumer<DynamoDbSettings.Builder> 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.
This is a convenience method that creates an instance of theDynamoDbSettings.Builder
avoiding the need to create one manually viaDynamoDbSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todynamoDbSettings(DynamoDbSettings)
.- Parameters:
dynamoDbSettings
- a consumer that will call methods onDynamoDbSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- 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 DMS in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theS3Settings.Builder
avoiding the need to create one manually viaS3Settings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Settings(S3Settings)
.- Parameters:
s3Settings
- a consumer that will call methods onS3Settings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
-
ServiceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam: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", }
- Parameters:
dmsTransferSettings
- The settings in JSON format for the DMS transfer type of source endpoint.Possible settings include the following:
-
ServiceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam: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:
- Returns a reference to this object so that method calls can be chained together.
-
-
dmsTransferSettings
default CreateEndpointRequest.Builder dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings) The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
-
ServiceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam: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:
This is a convenience method that creates an instance of the{ "ServiceAccessRoleArn": "string", "BucketName": "string", }
DmsTransferSettings.Builder
avoiding the need to create one manually viaDmsTransferSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todmsTransferSettings(DmsTransferSettings)
.- Parameters:
dmsTransferSettings
- a consumer that will call methods onDmsTransferSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
mongoDbSettings
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
- Parameters:
mongoDbSettings
- Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mongoDbSettings
default CreateEndpointRequest.Builder mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings) Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
This is a convenience method that creates an instance of theMongoDbSettings.Builder
avoiding the need to create one manually viaMongoDbSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomongoDbSettings(MongoDbSettings)
.- Parameters:
mongoDbSettings
- a consumer that will call methods onMongoDbSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
kinesisSettings
default CreateEndpointRequest.Builder kinesisSettings(Consumer<KinesisSettings.Builder> 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.
This is a convenience method that creates an instance of theKinesisSettings.Builder
avoiding the need to create one manually viaKinesisSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokinesisSettings(KinesisSettings)
.- Parameters:
kinesisSettings
- a consumer that will call methods onKinesisSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theKafkaSettings.Builder
avoiding the need to create one manually viaKafkaSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokafkaSettings(KafkaSettings)
.- Parameters:
kafkaSettings
- a consumer that will call methods onKafkaSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
elasticsearchSettings
default CreateEndpointRequest.Builder elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> 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.
This is a convenience method that creates an instance of theElasticsearchSettings.Builder
avoiding the need to create one manually viaElasticsearchSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toelasticsearchSettings(ElasticsearchSettings)
.- Parameters:
elasticsearchSettings
- a consumer that will call methods onElasticsearchSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
neptuneSettings
default CreateEndpointRequest.Builder neptuneSettings(Consumer<NeptuneSettings.Builder> 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.
This is a convenience method that creates an instance of theNeptuneSettings.Builder
avoiding the need to create one manually viaNeptuneSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toneptuneSettings(NeptuneSettings)
.- Parameters:
neptuneSettings
- a consumer that will call methods onNeptuneSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
redshiftSettings
Sets the value of the RedshiftSettings property for this object.- Parameters:
redshiftSettings
- The new value for the RedshiftSettings property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
redshiftSettings
default CreateEndpointRequest.Builder redshiftSettings(Consumer<RedshiftSettings.Builder> redshiftSettings) Sets the value of the RedshiftSettings property for this object. This is a convenience method that creates an instance of theRedshiftSettings.Builder
avoiding the need to create one manually viaRedshiftSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toredshiftSettings(RedshiftSettings)
.- Parameters:
redshiftSettings
- a consumer that will call methods onRedshiftSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
postgreSQLSettings
default CreateEndpointRequest.Builder postgreSQLSettings(Consumer<PostgreSQLSettings.Builder> 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.
This is a convenience method that creates an instance of thePostgreSQLSettings.Builder
avoiding the need to create one manually viaPostgreSQLSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topostgreSQLSettings(PostgreSQLSettings)
.- Parameters:
postgreSQLSettings
- a consumer that will call methods onPostgreSQLSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theMySQLSettings.Builder
avoiding the need to create one manually viaMySQLSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomySQLSettings(MySQLSettings)
.- Parameters:
mySQLSettings
- a consumer that will call methods onMySQLSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
oracleSettings
default CreateEndpointRequest.Builder oracleSettings(Consumer<OracleSettings.Builder> 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.
This is a convenience method that creates an instance of theOracleSettings.Builder
avoiding the need to create one manually viaOracleSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooracleSettings(OracleSettings)
.- Parameters:
oracleSettings
- a consumer that will call methods onOracleSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sybaseSettings
default CreateEndpointRequest.Builder sybaseSettings(Consumer<SybaseSettings.Builder> 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.
This is a convenience method that creates an instance of theSybaseSettings.Builder
avoiding the need to create one manually viaSybaseSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosybaseSettings(SybaseSettings)
.- Parameters:
sybaseSettings
- a consumer that will call methods onSybaseSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
microsoftSQLServerSettings
CreateEndpointRequest.Builder microsoftSQLServerSettings(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
microsoftSQLServerSettings
default CreateEndpointRequest.Builder microsoftSQLServerSettings(Consumer<MicrosoftSQLServerSettings.Builder> 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.
This is a convenience method that creates an instance of theMicrosoftSQLServerSettings.Builder
avoiding the need to create one manually viaMicrosoftSQLServerSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomicrosoftSQLServerSettings(MicrosoftSQLServerSettings)
.- Parameters:
microsoftSQLServerSettings
- a consumer that will call methods onMicrosoftSQLServerSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
ibmDb2Settings
default CreateEndpointRequest.Builder ibmDb2Settings(Consumer<IBMDb2Settings.Builder> 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.
This is a convenience method that creates an instance of theIBMDb2Settings.Builder
avoiding the need to create one manually viaIBMDb2Settings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toibmDb2Settings(IBMDb2Settings)
.- Parameters:
ibmDb2Settings
- a consumer that will call methods onIBMDb2Settings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceIdentifier
A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
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 asExample-App-ARN1
. For example, this value might result in theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.- Parameters:
resourceIdentifier
- A friendly name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
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 asExample-App-ARN1
. For example, this value might result in theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
docDbSettings
Sets the value of the DocDbSettings property for this object.- Parameters:
docDbSettings
- The new value for the DocDbSettings property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
docDbSettings
Sets the value of the DocDbSettings property for this object. This is a convenience method that creates an instance of theDocDbSettings.Builder
avoiding the need to create one manually viaDocDbSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocDbSettings(DocDbSettings)
.- Parameters:
docDbSettings
- a consumer that will call methods onDocDbSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
redisSettings
Settings in JSON format for the target Redis endpoint.
- Parameters:
redisSettings
- Settings in JSON format for the target Redis endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
redisSettings
Settings in JSON format for the target Redis endpoint.
This is a convenience method that creates an instance of theRedisSettings.Builder
avoiding the need to create one manually viaRedisSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toredisSettings(RedisSettings)
.- Parameters:
redisSettings
- a consumer that will call methods onRedisSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
gcpMySQLSettings
Settings in JSON format for the source GCP MySQL endpoint.
- Parameters:
gcpMySQLSettings
- Settings in JSON format for the source GCP MySQL endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gcpMySQLSettings
default CreateEndpointRequest.Builder gcpMySQLSettings(Consumer<GcpMySQLSettings.Builder> gcpMySQLSettings) Settings in JSON format for the source GCP MySQL endpoint.
This is a convenience method that creates an instance of theGcpMySQLSettings.Builder
avoiding the need to create one manually viaGcpMySQLSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togcpMySQLSettings(GcpMySQLSettings)
.- Parameters:
gcpMySQLSettings
- a consumer that will call methods onGcpMySQLSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
timestreamSettings
Settings in JSON format for the target Amazon Timestream endpoint.
- Parameters:
timestreamSettings
- Settings in JSON format for the target Amazon Timestream endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timestreamSettings
default CreateEndpointRequest.Builder timestreamSettings(Consumer<TimestreamSettings.Builder> timestreamSettings) Settings in JSON format for the target Amazon Timestream endpoint.
This is a convenience method that creates an instance of theTimestreamSettings.Builder
avoiding the need to create one manually viaTimestreamSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimestreamSettings(TimestreamSettings)
.- Parameters:
timestreamSettings
- a consumer that will call methods onTimestreamSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-