@Generated(value="software.amazon.awssdk:codegen") public final class CreateEndpointRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateEndpointRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateEndpointRequest.Builder |
builder() |
String |
certificateArn()
The Amazon Resource Name (ARN) for the certificate.
|
String |
databaseName()
The name of the endpoint database.
|
DmsTransferSettings |
dmsTransferSettings()
The settings in JSON format for the DMS transfer type of source endpoint.
|
DocDbSettings |
docDbSettings()
Returns the value of the DocDbSettings property for this object.
|
DynamoDbSettings |
dynamoDbSettings()
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
ElasticsearchSettings |
elasticsearchSettings()
Settings in JSON format for the target OpenSearch endpoint.
|
String |
endpointIdentifier()
The database endpoint identifier.
|
ReplicationEndpointTypeValue |
endpointType()
The type of endpoint.
|
String |
endpointTypeAsString()
The type of endpoint.
|
String |
engineName()
The type of engine for the endpoint.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
externalTableDefinition()
The external table definition.
|
String |
extraConnectionAttributes()
Additional attributes associated with the connection.
|
GcpMySQLSettings |
gcpMySQLSettings()
Settings in JSON format for the source GCP MySQL endpoint.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
IBMDb2Settings |
ibmDb2Settings()
Settings in JSON format for the source IBM Db2 LUW endpoint.
|
KafkaSettings |
kafkaSettings()
Settings in JSON format for the target Apache Kafka endpoint.
|
KinesisSettings |
kinesisSettings()
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
|
String |
kmsKeyId()
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
MicrosoftSQLServerSettings |
microsoftSQLServerSettings()
Settings in JSON format for the source and target Microsoft SQL Server endpoint.
|
MongoDbSettings |
mongoDbSettings()
Settings in JSON format for the source MongoDB endpoint.
|
MySQLSettings |
mySQLSettings()
Settings in JSON format for the source and target MySQL endpoint.
|
NeptuneSettings |
neptuneSettings()
Settings in JSON format for the target Amazon Neptune endpoint.
|
OracleSettings |
oracleSettings()
Settings in JSON format for the source and target Oracle endpoint.
|
String |
password()
The password to be used to log in to the endpoint database.
|
Integer |
port()
The port used by the endpoint database.
|
PostgreSQLSettings |
postgreSQLSettings()
Settings in JSON format for the source and target PostgreSQL endpoint.
|
RedisSettings |
redisSettings()
Settings in JSON format for the target Redis endpoint.
|
RedshiftSettings |
redshiftSettings()
Returns the value of the RedshiftSettings property for this object.
|
String |
resourceIdentifier()
A friendly name for the resource identifier at the end of the
EndpointArn response parameter that is
returned in the created Endpoint object. |
S3Settings |
s3Settings()
Settings in JSON format for the target Amazon S3 endpoint.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateEndpointRequest.Builder> |
serializableBuilderClass() |
String |
serverName()
The name of the server where the endpoint database resides.
|
String |
serviceAccessRoleArn()
The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
|
DmsSslModeValue |
sslMode()
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
String |
sslModeAsString()
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
SybaseSettings |
sybaseSettings()
Settings in JSON format for the source and target SAP ASE endpoint.
|
List<Tag> |
tags()
One or more tags to be assigned to the endpoint.
|
TimestreamSettings |
timestreamSettings()
Settings in JSON format for the target Amazon Timestream endpoint.
|
CreateEndpointRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
username()
The user name to be used to log in to the endpoint database.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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.
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().
source and target.ReplicationEndpointTypeValuepublic 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().
source and target.ReplicationEndpointTypeValuepublic final String engineName()
The type of engine for the endpoint. Valid values, depending on the EndpointType value, include
"mysql", "oracle", "postgres", "mariadb",
"aurora", "aurora-postgresql", "opensearch", "redshift",
"s3", "db2", "db2-zos", "azuredb", "sybase",
"dynamodb", "mongodb", "kinesis", "kafka",
"elasticsearch", "docdb", "sqlserver", "neptune", and
"babelfish".
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".public final String username()
The user name to be used to log in to the endpoint database.
public final String password()
The password to be used to log in to the endpoint database.
public final String serverName()
The name of the server where the endpoint database resides.
public final Integer port()
The port used by the endpoint database.
public final String 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.
targetDbType.public final String extraConnectionAttributes()
Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.
public final String 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.
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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
One or more tags to be assigned to the endpoint.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final String certificateArn()
The Amazon Resource Name (ARN) for the certificate.
public final DmsSslModeValue sslMode()
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
If the service returns an enum value that is not available in the current SDK version, sslMode will
return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
sslModeAsString().
noneDmsSslModeValuepublic final String sslModeAsString()
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
If the service returns an enum value that is not available in the current SDK version, sslMode will
return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
sslModeAsString().
noneDmsSslModeValuepublic final String 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.
iam:PassRole action.public final String externalTableDefinition()
The external table definition.
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.
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.
public final DmsTransferSettings 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 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", }
Possible settings 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", }
public final MongoDbSettings 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.
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.
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.
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.
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.
public final RedshiftSettings redshiftSettings()
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.
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.
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.
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.
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.
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.
public final String resourceIdentifier()
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is
returned in the created Endpoint object. The value for this parameter can have up to 31 characters.
It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two
consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this
value might result in the EndpointArn value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a
ResourceIdentifier value, DMS generates a default identifier value for the end of
EndpointArn.
EndpointArn response parameter
that is returned in the created Endpoint object. The value for this parameter can have up to
31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a
hyphen or contain two consecutive hyphens, and can only begin with a letter, such as
Example-App-ARN1. For example, this value might result in the EndpointArn value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a
ResourceIdentifier value, DMS generates a default identifier value for the end of
EndpointArn.public final DocDbSettings docDbSettings()
public final RedisSettings redisSettings()
Settings in JSON format for the target Redis endpoint.
public final GcpMySQLSettings gcpMySQLSettings()
Settings in JSON format for the source GCP MySQL endpoint.
public final TimestreamSettings timestreamSettings()
Settings in JSON format for the target Amazon Timestream endpoint.
public CreateEndpointRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>toBuilder in class DatabaseMigrationRequestpublic static CreateEndpointRequest.Builder builder()
public static Class<? extends CreateEndpointRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.