public static interface CreateEndpointRequest.Builder extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>
Modifier and Type | Method and Description |
---|---|
CreateEndpointRequest.Builder |
certificateArn(String certificateArn)
The Amazon Resource Name (ARN) for the certificate.
|
CreateEndpointRequest.Builder |
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.
|
CreateEndpointRequest.Builder |
dmsTransferSettings(DmsTransferSettings dmsTransferSettings)
The settings in JSON format for the DMS transfer type of source endpoint.
|
default CreateEndpointRequest.Builder |
dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
CreateEndpointRequest.Builder |
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 Elasticsearch endpoint.
|
CreateEndpointRequest.Builder |
elasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
Settings in JSON format for the target Elasticsearch endpoint.
|
CreateEndpointRequest.Builder |
endpointIdentifier(String endpointIdentifier)
The database endpoint identifier.
|
CreateEndpointRequest.Builder |
endpointType(ReplicationEndpointTypeValue endpointType)
The type of endpoint.
|
CreateEndpointRequest.Builder |
endpointType(String endpointType)
The type of endpoint.
|
CreateEndpointRequest.Builder |
engineName(String engineName)
The type of engine for the endpoint.
|
CreateEndpointRequest.Builder |
externalTableDefinition(String externalTableDefinition)
The external table definition.
|
CreateEndpointRequest.Builder |
extraConnectionAttributes(String extraConnectionAttributes)
Additional attributes associated with the connection.
|
default CreateEndpointRequest.Builder |
kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)
Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
|
CreateEndpointRequest.Builder |
kinesisSettings(KinesisSettings kinesisSettings)
Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
|
CreateEndpointRequest.Builder |
kmsKeyId(String kmsKeyId)
The AWS KMS key identifier to use to encrypt the connection parameters.
|
default CreateEndpointRequest.Builder |
mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)
Settings in JSON format for the source MongoDB endpoint.
|
CreateEndpointRequest.Builder |
mongoDbSettings(MongoDbSettings mongoDbSettings)
Settings in JSON format for the source MongoDB endpoint.
|
CreateEndpointRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateEndpointRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateEndpointRequest.Builder |
password(String password)
The password to be used to log in to the endpoint database.
|
CreateEndpointRequest.Builder |
port(Integer port)
The port used by the endpoint database.
|
default CreateEndpointRequest.Builder |
s3Settings(Consumer<S3Settings.Builder> s3Settings)
Settings in JSON format for the target Amazon S3 endpoint.
|
CreateEndpointRequest.Builder |
s3Settings(S3Settings s3Settings)
Settings in JSON format for the target Amazon S3 endpoint.
|
CreateEndpointRequest.Builder |
serverName(String serverName)
The name of the server where the endpoint database resides.
|
CreateEndpointRequest.Builder |
serviceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
|
CreateEndpointRequest.Builder |
sslMode(DmsSslModeValue sslMode)
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
CreateEndpointRequest.Builder |
sslMode(String sslMode)
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
CreateEndpointRequest.Builder |
tags(Collection<Tag> tags)
Tags to be added to the endpoint.
|
CreateEndpointRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Tags to be added to the endpoint.
|
CreateEndpointRequest.Builder |
tags(Tag... tags)
Tags to be added to the endpoint.
|
CreateEndpointRequest.Builder |
username(String username)
The user name to be used to log in to the endpoint database.
|
build
overrideConfiguration
copy
applyMutation, build
CreateEndpointRequest.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.
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.CreateEndpointRequest.Builder endpointType(String endpointType)
The type of endpoint.
endpointType
- The type of endpoint.ReplicationEndpointTypeValue
,
ReplicationEndpointTypeValue
CreateEndpointRequest.Builder endpointType(ReplicationEndpointTypeValue endpointType)
The type of endpoint.
endpointType
- The type of endpoint.ReplicationEndpointTypeValue
,
ReplicationEndpointTypeValue
CreateEndpointRequest.Builder engineName(String engineName)
The type of engine for the endpoint. Valid values, depending on the EndPointType
value, include
mysql
, oracle
, postgres
, mariadb
, aurora
,
aurora-postgresql
, redshift
, s3
, db2
,
azuredb
, sybase
, dynamodb
, mongodb
, and
sqlserver
.
engineName
- The type of engine for the endpoint. Valid values, depending on the EndPointType
value,
include mysql
, oracle
, postgres
, mariadb
,
aurora
, aurora-postgresql
, redshift
, s3
,
db2
, azuredb
, sybase
, dynamodb
,
mongodb
, and sqlserver
.CreateEndpointRequest.Builder username(String username)
The user name to be used to log in to the endpoint database.
username
- The user name to be used to log in to the endpoint database.CreateEndpointRequest.Builder password(String password)
The password to be used to log in to the endpoint database.
password
- The password to be used to log in to the endpoint database.CreateEndpointRequest.Builder serverName(String serverName)
The name of the server where the endpoint database resides.
serverName
- The name of the server where the endpoint database resides.CreateEndpointRequest.Builder port(Integer port)
The port used by the endpoint database.
port
- The port used by the endpoint database.CreateEndpointRequest.Builder databaseName(String databaseName)
The name of the endpoint database.
databaseName
- The name of the endpoint database.CreateEndpointRequest.Builder extraConnectionAttributes(String extraConnectionAttributes)
Additional attributes associated with the connection.
extraConnectionAttributes
- Additional attributes associated with the connection.CreateEndpointRequest.Builder kmsKeyId(String kmsKeyId)
The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the
KmsKeyId
parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default
encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
kmsKeyId
- The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value
for the KmsKeyId
parameter, then AWS DMS uses your default encryption key. AWS KMS
creates the default encryption key for your AWS account. Your AWS account has a different default
encryption key for each AWS Region.CreateEndpointRequest.Builder tags(Collection<Tag> tags)
Tags to be added to the endpoint.
tags
- Tags to be added to the endpoint.CreateEndpointRequest.Builder tags(Tag... tags)
Tags to be added to the endpoint.
tags
- Tags to be added to the endpoint.CreateEndpointRequest.Builder tags(Consumer<Tag.Builder>... tags)
Tags to be added to the endpoint.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
CreateEndpointRequest.Builder certificateArn(String certificateArn)
The Amazon Resource Name (ARN) for the certificate.
certificateArn
- The Amazon Resource Name (ARN) for the certificate.CreateEndpointRequest.Builder sslMode(String sslMode)
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
none
, require
, verify-ca
, verify-full
. The default value
is none
.
sslMode
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four
values: none
, require
, verify-ca
, verify-full
. The
default value is none
.DmsSslModeValue
,
DmsSslModeValue
CreateEndpointRequest.Builder sslMode(DmsSslModeValue sslMode)
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
none
, require
, verify-ca
, verify-full
. The default value
is none
.
sslMode
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four
values: none
, require
, verify-ca
, verify-full
. The
default value is none
.DmsSslModeValue
,
DmsSslModeValue
CreateEndpointRequest.Builder serviceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
serviceAccessRoleArn
- The Amazon Resource Name (ARN) for the service access role that you want to use to create the
endpoint.CreateEndpointRequest.Builder externalTableDefinition(String externalTableDefinition)
The external table definition.
externalTableDefinition
- The external table definition.CreateEndpointRequest.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.
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.default CreateEndpointRequest.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 theDynamoDbSettings.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)
.dynamoDbSettings
- a consumer that will call methods on DynamoDbSettings.Builder
dynamoDbSettings(DynamoDbSettings)
CreateEndpointRequest.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.
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.default CreateEndpointRequest.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 theS3Settings.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)
.s3Settings
- a consumer that will call methods on S3Settings.Builder
s3Settings(S3Settings)
CreateEndpointRequest.Builder dmsTransferSettings(DmsTransferSettings dmsTransferSettings)
The settings in JSON format for the DMS transfer type of source endpoint.
Possible attributes include the following:
serviceAccessRoleArn
- The IAM role that has permission to access the Amazon S3 bucket.
bucketName
- The name of the S3 bucket to use.
compressionType
- An optional parameter to use GZIP to compress the target files. To use GZIP,
set this value to NONE
(the default). To keep the files uncompressed, don't use this value.
Shorthand syntax for these attributes is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these attributes is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
dmsTransferSettings
- The settings in JSON format for the DMS transfer type of source endpoint.
Possible attributes include the following:
serviceAccessRoleArn
- The IAM role that has permission to access the Amazon S3 bucket.
bucketName
- The name of the S3 bucket to use.
compressionType
- An optional parameter to use GZIP to compress the target files. To use
GZIP, set this value to NONE
(the default). To keep the files uncompressed, don't use
this value.
Shorthand syntax for these attributes is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these attributes is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
default CreateEndpointRequest.Builder dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)
The settings in JSON format for the DMS transfer type of source endpoint.
Possible attributes include the following:
serviceAccessRoleArn
- The IAM role that has permission to access the Amazon S3 bucket.
bucketName
- The name of the S3 bucket to use.
compressionType
- An optional parameter to use GZIP to compress the target files. To use GZIP,
set this value to NONE
(the default). To keep the files uncompressed, don't use this value.
Shorthand syntax for these attributes is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these attributes is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
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)
.dmsTransferSettings
- a consumer that will call methods on DmsTransferSettings.Builder
dmsTransferSettings(DmsTransferSettings)
CreateEndpointRequest.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.
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.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 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 theMongoDbSettings.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)
.mongoDbSettings
- a consumer that will call methods on MongoDbSettings.Builder
mongoDbSettings(MongoDbSettings)
CreateEndpointRequest.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.
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.default CreateEndpointRequest.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 theKinesisSettings.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)
.kinesisSettings
- a consumer that will call methods on KinesisSettings.Builder
kinesisSettings(KinesisSettings)
CreateEndpointRequest.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.
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.default CreateEndpointRequest.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 theElasticsearchSettings.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)
.elasticsearchSettings
- a consumer that will call methods on ElasticsearchSettings.Builder
elasticsearchSettings(ElasticsearchSettings)
CreateEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.