com.amazonaws.services.databasemigrationservice.model

Class CreateEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.databasemigrationservice.model.CreateEndpointRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEndpointRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateEndpointRequest()

Method Summary

Modifier and Type	Method and Description
CreateEndpointRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCertificateArn() The Amazon Resource Number (ARN) for the certificate.
String	getDatabaseName() The name of the endpoint database.
DynamoDbSettings	getDynamoDbSettings() Settings in JSON format for the target Amazon DynamoDB endpoint.
String	getEndpointIdentifier() The database endpoint identifier.
String	getEndpointType() The type of endpoint.
String	getEngineName() The type of engine for the endpoint.
String	getExtraConnectionAttributes() Additional attributes associated with the connection.
String	getKmsKeyId() The KMS key identifier that will be used to encrypt the connection parameters.
MongoDbSettings	getMongoDbSettings() Settings in JSON format for the source MongoDB endpoint.
String	getPassword() The password to be used to login to the endpoint database.
Integer	getPort() The port used by the endpoint database.
S3Settings	getS3Settings() Settings in JSON format for the target S3 endpoint.
String	getServerName() The name of the server where the endpoint database resides.
String	getSslMode() The SSL mode to use for the SSL connection.
List<Tag>	getTags() Tags to be added to the endpoint.
String	getUsername() The user name to be used to login to the endpoint database.
int	hashCode()
void	setCertificateArn(String certificateArn) The Amazon Resource Number (ARN) for the certificate.
void	setDatabaseName(String databaseName) The name of the endpoint database.
void	setDynamoDbSettings(DynamoDbSettings dynamoDbSettings) Settings in JSON format for the target Amazon DynamoDB endpoint.
void	setEndpointIdentifier(String endpointIdentifier) The database endpoint identifier.
void	setEndpointType(ReplicationEndpointTypeValue endpointType) The type of endpoint.
void	setEndpointType(String endpointType) The type of endpoint.
void	setEngineName(String engineName) The type of engine for the endpoint.
void	setExtraConnectionAttributes(String extraConnectionAttributes) Additional attributes associated with the connection.
void	setKmsKeyId(String kmsKeyId) The KMS key identifier that will be used to encrypt the connection parameters.
void	setMongoDbSettings(MongoDbSettings mongoDbSettings) Settings in JSON format for the source MongoDB endpoint.
void	setPassword(String password) The password to be used to login to the endpoint database.
void	setPort(Integer port) The port used by the endpoint database.
void	setS3Settings(S3Settings s3Settings) Settings in JSON format for the target S3 endpoint.
void	setServerName(String serverName) The name of the server where the endpoint database resides.
void	setSslMode(DmsSslModeValue sslMode) The SSL mode to use for the SSL connection.
void	setSslMode(String sslMode) The SSL mode to use for the SSL connection.
void	setTags(Collection<Tag> tags) Tags to be added to the endpoint.
void	setUsername(String username) The user name to be used to login to the endpoint database.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateEndpointRequest	withCertificateArn(String certificateArn) The Amazon Resource Number (ARN) for the certificate.
CreateEndpointRequest	withDatabaseName(String databaseName) The name of the endpoint database.
CreateEndpointRequest	withDynamoDbSettings(DynamoDbSettings dynamoDbSettings) Settings in JSON format for the target Amazon DynamoDB endpoint.
CreateEndpointRequest	withEndpointIdentifier(String endpointIdentifier) The database endpoint identifier.
CreateEndpointRequest	withEndpointType(ReplicationEndpointTypeValue endpointType) The type of endpoint.
CreateEndpointRequest	withEndpointType(String endpointType) The type of endpoint.
CreateEndpointRequest	withEngineName(String engineName) The type of engine for the endpoint.
CreateEndpointRequest	withExtraConnectionAttributes(String extraConnectionAttributes) Additional attributes associated with the connection.
CreateEndpointRequest	withKmsKeyId(String kmsKeyId) The KMS key identifier that will be used to encrypt the connection parameters.
CreateEndpointRequest	withMongoDbSettings(MongoDbSettings mongoDbSettings) Settings in JSON format for the source MongoDB endpoint.
CreateEndpointRequest	withPassword(String password) The password to be used to login to the endpoint database.
CreateEndpointRequest	withPort(Integer port) The port used by the endpoint database.
CreateEndpointRequest	withS3Settings(S3Settings s3Settings) Settings in JSON format for the target S3 endpoint.
CreateEndpointRequest	withServerName(String serverName) The name of the server where the endpoint database resides.
CreateEndpointRequest	withSslMode(DmsSslModeValue sslMode) The SSL mode to use for the SSL connection.
CreateEndpointRequest	withSslMode(String sslMode) The SSL mode to use for the SSL connection.
CreateEndpointRequest	withTags(Collection<Tag> tags) Tags to be added to the endpoint.
CreateEndpointRequest	withTags(Tag... tags) Tags to be added to the endpoint.
CreateEndpointRequest	withUsername(String username) The user name to be used to login to the endpoint database.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateEndpointRequest

public CreateEndpointRequest()

Method Detail

setEndpointIdentifier

public void setEndpointIdentifier(String endpointIdentifier)

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Parameters:

endpointIdentifier - The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

getEndpointIdentifier

public String getEndpointIdentifier()

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Returns:

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.

withEndpointIdentifier

public CreateEndpointRequest withEndpointIdentifier(String endpointIdentifier)

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Parameters:

endpointIdentifier - The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndpointType

public void setEndpointType(String endpointType)

The type of endpoint.

Parameters:

endpointType - The type of endpoint.

See Also:

ReplicationEndpointTypeValue

getEndpointType

public String getEndpointType()

The type of endpoint.

Returns:

The type of endpoint.

See Also:

ReplicationEndpointTypeValue

withEndpointType

public CreateEndpointRequest withEndpointType(String endpointType)

The type of endpoint.

Parameters:

endpointType - The type of endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicationEndpointTypeValue

setEndpointType

public void setEndpointType(ReplicationEndpointTypeValue endpointType)

The type of endpoint.

Parameters:

endpointType - The type of endpoint.

See Also:

ReplicationEndpointTypeValue

withEndpointType

public CreateEndpointRequest withEndpointType(ReplicationEndpointTypeValue endpointType)

The type of endpoint.

Parameters:

endpointType - The type of endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicationEndpointTypeValue

setEngineName

public void setEngineName(String engineName)

The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Parameters:

engineName - The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

getEngineName

public String getEngineName()

The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Returns:

The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

withEngineName

public CreateEndpointRequest withEngineName(String engineName)

The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Parameters:

engineName - The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUsername

public void setUsername(String username)

The user name to be used to login to the endpoint database.

Parameters:

username - The user name to be used to login to the endpoint database.

getUsername

public String getUsername()

The user name to be used to login to the endpoint database.

Returns:

The user name to be used to login to the endpoint database.

withUsername

public CreateEndpointRequest withUsername(String username)

The user name to be used to login to the endpoint database.

Parameters:

username - The user name to be used to login to the endpoint database.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPassword

public void setPassword(String password)

The password to be used to login to the endpoint database.

Parameters:

password - The password to be used to login to the endpoint database.

getPassword

public String getPassword()

The password to be used to login to the endpoint database.

Returns:

The password to be used to login to the endpoint database.

withPassword

public CreateEndpointRequest withPassword(String password)

The password to be used to login to the endpoint database.

Parameters:

password - The password to be used to login to the endpoint database.

Returns:

Returns a reference to this object so that method calls can be chained together.

setServerName

public void setServerName(String serverName)

The name of the server where the endpoint database resides.

Parameters:

serverName - The name of the server where the endpoint database resides.

getServerName

public String getServerName()

The name of the server where the endpoint database resides.

Returns:

The name of the server where the endpoint database resides.

withServerName

public CreateEndpointRequest withServerName(String serverName)

The name of the server where the endpoint database resides.

Parameters:

serverName - The name of the server where the endpoint database resides.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPort

public void setPort(Integer port)

The port used by the endpoint database.

Parameters:

port - The port used by the endpoint database.

getPort

public Integer getPort()

The port used by the endpoint database.

Returns:

The port used by the endpoint database.

withPort

public CreateEndpointRequest withPort(Integer port)

The port used by the endpoint database.

Parameters:

port - The port used by the endpoint database.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatabaseName

public void setDatabaseName(String databaseName)

The name of the endpoint database.

Parameters:

databaseName - The name of the endpoint database.

getDatabaseName

public String getDatabaseName()

The name of the endpoint database.

Returns:

The name of the endpoint database.

withDatabaseName

public CreateEndpointRequest withDatabaseName(String databaseName)

The name of the endpoint database.

Parameters:

databaseName - The name of the endpoint database.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExtraConnectionAttributes

public void setExtraConnectionAttributes(String extraConnectionAttributes)

Additional attributes associated with the connection.

Parameters:

extraConnectionAttributes - Additional attributes associated with the connection.

getExtraConnectionAttributes

public String getExtraConnectionAttributes()

Additional attributes associated with the connection.

Returns:

Additional attributes associated with the connection.

withExtraConnectionAttributes

public CreateEndpointRequest withExtraConnectionAttributes(String extraConnectionAttributes)

Additional attributes associated with the connection.

Parameters:

extraConnectionAttributes - Additional attributes associated with the connection.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.

Parameters:

kmsKeyId - The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.

getKmsKeyId

public String getKmsKeyId()

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.

Returns:

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.

withKmsKeyId

public CreateEndpointRequest withKmsKeyId(String kmsKeyId)

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.

Parameters:

kmsKeyId - The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Tags to be added to the endpoint.

Returns:

Tags to be added to the endpoint.

setTags

public void setTags(Collection<Tag> tags)

Tags to be added to the endpoint.

Parameters:

tags - Tags to be added to the endpoint.

withTags

public CreateEndpointRequest withTags(Tag... tags)

Tags to be added to the endpoint.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags to be added to the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateEndpointRequest withTags(Collection<Tag> tags)

Tags to be added to the endpoint.

Parameters:

tags - Tags to be added to the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCertificateArn

public void setCertificateArn(String certificateArn)

The Amazon Resource Number (ARN) for the certificate.

Parameters:

certificateArn - The Amazon Resource Number (ARN) for the certificate.

getCertificateArn

public String getCertificateArn()

The Amazon Resource Number (ARN) for the certificate.

Returns:

The Amazon Resource Number (ARN) for the certificate.

withCertificateArn

public CreateEndpointRequest withCertificateArn(String certificateArn)

The Amazon Resource Number (ARN) for the certificate.

Parameters:

certificateArn - The Amazon Resource Number (ARN) for the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSslMode

public void setSslMode(String sslMode)

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Parameters:

sslMode - The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

See Also:

DmsSslModeValue

getSslMode

public String getSslMode()

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Returns:

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

See Also:

DmsSslModeValue

withSslMode

public CreateEndpointRequest withSslMode(String sslMode)

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Parameters:

sslMode - The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DmsSslModeValue

setSslMode

public void setSslMode(DmsSslModeValue sslMode)

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Parameters:

sslMode - The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

See Also:

DmsSslModeValue

withSslMode

public CreateEndpointRequest withSslMode(DmsSslModeValue sslMode)

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Parameters:

sslMode - The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DmsSslModeValue

setDynamoDbSettings

public void setDynamoDbSettings(DynamoDbSettings dynamoDbSettings)

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Parameters:

dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

getDynamoDbSettings

public DynamoDbSettings getDynamoDbSettings()

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Returns:

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

withDynamoDbSettings

public CreateEndpointRequest withDynamoDbSettings(DynamoDbSettings dynamoDbSettings)

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Parameters:

dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3Settings

public void setS3Settings(S3Settings s3Settings)

Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

Parameters:

s3Settings - Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

getS3Settings

public S3Settings getS3Settings()

Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

Returns:

Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

withS3Settings

public CreateEndpointRequest withS3Settings(S3Settings s3Settings)

Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

Parameters:

s3Settings - Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMongoDbSettings

public void setMongoDbSettings(MongoDbSettings mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Parameters:

mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

getMongoDbSettings

public MongoDbSettings getMongoDbSettings()

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Returns:

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

withMongoDbSettings

public CreateEndpointRequest withMongoDbSettings(MongoDbSettings mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Parameters:

mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateEndpointRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()