Class CreateEndpointRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
-
- software.amazon.awssdk.services.databasemigration.model.CreateEndpointRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEndpointRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateEndpointRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateEndpointRequest.Builderbuilder()StringcertificateArn()The Amazon Resource Name (ARN) for the certificate.StringdatabaseName()The name of the endpoint database.DmsTransferSettingsdmsTransferSettings()The settings in JSON format for the DMS transfer type of source endpoint.DocDbSettingsdocDbSettings()Returns the value of the DocDbSettings property for this object.DynamoDbSettingsdynamoDbSettings()Settings in JSON format for the target Amazon DynamoDB endpoint.ElasticsearchSettingselasticsearchSettings()Settings in JSON format for the target OpenSearch endpoint.StringendpointIdentifier()The database endpoint identifier.ReplicationEndpointTypeValueendpointType()The type of endpoint.StringendpointTypeAsString()The type of endpoint.StringengineName()The type of engine for the endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexternalTableDefinition()The external table definition.StringextraConnectionAttributes()Additional attributes associated with the connection.GcpMySQLSettingsgcpMySQLSettings()Settings in JSON format for the source GCP MySQL endpoint.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.IBMDb2SettingsibmDb2Settings()Settings in JSON format for the source IBM Db2 LUW endpoint.KafkaSettingskafkaSettings()Settings in JSON format for the target Apache Kafka endpoint.KinesisSettingskinesisSettings()Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.StringkmsKeyId()An KMS key identifier that is used to encrypt the connection parameters for the endpoint.MicrosoftSQLServerSettingsmicrosoftSQLServerSettings()Settings in JSON format for the source and target Microsoft SQL Server endpoint.MongoDbSettingsmongoDbSettings()Settings in JSON format for the source MongoDB endpoint.MySQLSettingsmySQLSettings()Settings in JSON format for the source and target MySQL endpoint.NeptuneSettingsneptuneSettings()Settings in JSON format for the target Amazon Neptune endpoint.OracleSettingsoracleSettings()Settings in JSON format for the source and target Oracle endpoint.Stringpassword()The password to be used to log in to the endpoint database.Integerport()The port used by the endpoint database.PostgreSQLSettingspostgreSQLSettings()Settings in JSON format for the source and target PostgreSQL endpoint.RedisSettingsredisSettings()Settings in JSON format for the target Redis endpoint.RedshiftSettingsredshiftSettings()Returns the value of the RedshiftSettings property for this object.StringresourceIdentifier()A friendly name for the resource identifier at the end of theEndpointArnresponse parameter that is returned in the createdEndpointobject.S3Settingss3Settings()Settings in JSON format for the target Amazon S3 endpoint.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateEndpointRequest.Builder>serializableBuilderClass()StringserverName()The name of the server where the endpoint database resides.StringserviceAccessRoleArn()The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.DmsSslModeValuesslMode()The Secure Sockets Layer (SSL) mode to use for the SSL connection.StringsslModeAsString()The Secure Sockets Layer (SSL) mode to use for the SSL connection.SybaseSettingssybaseSettings()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.TimestreamSettingstimestreamSettings()Settings in JSON format for the target Amazon Timestream endpoint.CreateEndpointRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringusername()The user name to be used to log in to the endpoint database.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
endpointIdentifier
public final String endpointIdentifier()
The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
- Returns:
- The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
-
endpointType
public final ReplicationEndpointTypeValue endpointType()
The type of endpoint. Valid values are
sourceandtarget.If the service returns an enum value that is not available in the current SDK version,
endpointTypewill returnReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromendpointTypeAsString().- Returns:
- The type of endpoint. Valid values are
sourceandtarget. - See Also:
ReplicationEndpointTypeValue
-
endpointTypeAsString
public final String endpointTypeAsString()
The type of endpoint. Valid values are
sourceandtarget.If the service returns an enum value that is not available in the current SDK version,
endpointTypewill returnReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromendpointTypeAsString().- Returns:
- The type of endpoint. Valid values are
sourceandtarget. - See Also:
ReplicationEndpointTypeValue
-
engineName
public final String engineName()
The type of engine for the endpoint. Valid values, depending on the
EndpointTypevalue, include"mysql","oracle","postgres","mariadb","aurora","aurora-postgresql","opensearch","redshift","s3","db2","db2-zos","azuredb","sybase","dynamodb","mongodb","kinesis","kafka","elasticsearch","docdb","sqlserver","neptune","babelfish",redshift-serverless,aurora-serverless,aurora-postgresql-serverless,gcp-mysql,azure-sql-managed-instance,redis,dms-transfer.- Returns:
- The type of engine for the endpoint. Valid values, depending on the
EndpointTypevalue, include"mysql","oracle","postgres","mariadb","aurora","aurora-postgresql","opensearch","redshift","s3","db2","db2-zos","azuredb","sybase","dynamodb","mongodb","kinesis","kafka","elasticsearch","docdb","sqlserver","neptune","babelfish",redshift-serverless,aurora-serverless,aurora-postgresql-serverless,gcp-mysql,azure-sql-managed-instance,redis,dms-transfer.
-
username
public final String username()
The user name to be used to log in to the endpoint database.
- Returns:
- The user name to be used to log in to the endpoint database.
-
password
public final String password()
The password to be used to log in to the endpoint database.
- Returns:
- The password to be used to log in to the endpoint database.
-
serverName
public final String serverName()
The name of the server where the endpoint database resides.
- Returns:
- The name of the server where the endpoint database resides.
-
port
public final Integer port()
The port used by the endpoint database.
- Returns:
- The port used by the endpoint database.
-
databaseName
public final String databaseName()
The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and
targetDbType.- Returns:
- 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.
-
extraConnectionAttributes
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.
- Returns:
- 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.
-
kmsKeyId
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
KmsKeyIdparameter, 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:
- An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
If you don't specify a value for the
KmsKeyIdparameter, 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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
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.- Returns:
- One or more tags to be assigned to the endpoint.
-
certificateArn
public final String certificateArn()
The Amazon Resource Name (ARN) for the certificate.
- Returns:
- The Amazon Resource Name (ARN) for the certificate.
-
sslMode
public final DmsSslModeValue sslMode()
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
noneIf the service returns an enum value that is not available in the current SDK version,
sslModewill returnDmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsslModeAsString().- Returns:
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
none - See Also:
DmsSslModeValue
-
sslModeAsString
public final String sslModeAsString()
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
noneIf the service returns an enum value that is not available in the current SDK version,
sslModewill returnDmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsslModeAsString().- Returns:
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
none - See Also:
DmsSslModeValue
-
serviceAccessRoleArn
public 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:PassRoleaction.- Returns:
- 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:PassRoleaction.
-
externalTableDefinition
public final String externalTableDefinition()
The external table definition.
- Returns:
- The external table definition.
-
dynamoDbSettings
public final DynamoDbSettings dynamoDbSettings()
Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
-
s3Settings
public final S3Settings s3Settings()
Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
-
dmsTransferSettings
public final DmsTransferSettings dmsTransferSettings()
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
-
ServiceAccessRoleArn- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam:PassRoleaction. -
BucketName- The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=stringJSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", }- Returns:
- The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
-
ServiceAccessRoleArn- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam:PassRoleaction. -
BucketName- The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=stringJSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", } -
-
-
mongoDbSettings
public final MongoDbSettings mongoDbSettings()
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
-
kinesisSettings
public final KinesisSettings kinesisSettings()
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
-
kafkaSettings
public final KafkaSettings kafkaSettings()
Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
-
elasticsearchSettings
public final ElasticsearchSettings elasticsearchSettings()
Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
-
neptuneSettings
public final NeptuneSettings neptuneSettings()
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
-
redshiftSettings
public final RedshiftSettings redshiftSettings()
Returns the value of the RedshiftSettings property for this object.- Returns:
- The value of the RedshiftSettings property for this object.
-
postgreSQLSettings
public final PostgreSQLSettings postgreSQLSettings()
Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
-
mySQLSettings
public final MySQLSettings mySQLSettings()
Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
-
oracleSettings
public final OracleSettings oracleSettings()
Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
-
sybaseSettings
public final SybaseSettings sybaseSettings()
Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
-
microsoftSQLServerSettings
public final MicrosoftSQLServerSettings microsoftSQLServerSettings()
Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
-
ibmDb2Settings
public final IBMDb2Settings ibmDb2Settings()
Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
- Returns:
- Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
-
resourceIdentifier
public final String resourceIdentifier()
A friendly name for the resource identifier at the end of the
EndpointArnresponse parameter that is returned in the createdEndpointobject. 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 theEndpointArnvaluearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify aResourceIdentifiervalue, DMS generates a default identifier value for the end ofEndpointArn.- Returns:
- A friendly name for the resource identifier at the end of the
EndpointArnresponse parameter that is returned in the createdEndpointobject. 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 theEndpointArnvaluearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify aResourceIdentifiervalue, DMS generates a default identifier value for the end ofEndpointArn.
-
docDbSettings
public final DocDbSettings docDbSettings()
Returns the value of the DocDbSettings property for this object.- Returns:
- The value of the DocDbSettings property for this object.
-
redisSettings
public final RedisSettings redisSettings()
Settings in JSON format for the target Redis endpoint.
- Returns:
- Settings in JSON format for the target Redis endpoint.
-
gcpMySQLSettings
public final GcpMySQLSettings gcpMySQLSettings()
Settings in JSON format for the source GCP MySQL endpoint.
- Returns:
- Settings in JSON format for the source GCP MySQL endpoint.
-
timestreamSettings
public final TimestreamSettings timestreamSettings()
Settings in JSON format for the target Amazon Timestream endpoint.
- Returns:
- Settings in JSON format for the target Amazon Timestream endpoint.
-
toBuilder
public CreateEndpointRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>- Specified by:
toBuilderin classDatabaseMigrationRequest
-
builder
public static CreateEndpointRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateEndpointRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-