@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Endpoint extends Object implements Serializable, Cloneable, StructuredPojo
Describes an endpoint of a database instance in response to operations such as the following:
CreateEndpoint
DescribeEndpoint
ModifyEndpoint
Constructor and Description |
---|
Endpoint() |
Modifier and Type | Method and Description |
---|---|
Endpoint |
clone() |
boolean |
equals(Object obj) |
String |
getCertificateArn()
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
|
String |
getDatabaseName()
The name of the database at the endpoint.
|
DmsTransferSettings |
getDmsTransferSettings()
The settings for the DMS Transfer type source.
|
DocDbSettings |
getDocDbSettings() |
DynamoDbSettings |
getDynamoDbSettings()
The settings for the DynamoDB target endpoint.
|
ElasticsearchSettings |
getElasticsearchSettings()
The settings for the OpenSearch source endpoint.
|
String |
getEndpointArn()
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
|
String |
getEndpointIdentifier()
The database endpoint identifier.
|
String |
getEndpointType()
The type of endpoint.
|
String |
getEngineDisplayName()
The expanded name for the engine name.
|
String |
getEngineName()
The database engine name.
|
String |
getExternalId()
Value returned by a call to CreateEndpoint that can be used for cross-account validation.
|
String |
getExternalTableDefinition()
The external table definition.
|
String |
getExtraConnectionAttributes()
Additional connection attributes used to connect to the endpoint.
|
GcpMySQLSettings |
getGcpMySQLSettings()
Settings in JSON format for the source GCP MySQL endpoint.
|
IBMDb2Settings |
getIBMDb2Settings()
The settings for the IBM Db2 LUW source endpoint.
|
KafkaSettings |
getKafkaSettings()
The settings for the Apache Kafka target endpoint.
|
KinesisSettings |
getKinesisSettings()
The settings for the Amazon Kinesis target endpoint.
|
String |
getKmsKeyId()
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
MicrosoftSQLServerSettings |
getMicrosoftSQLServerSettings()
The settings for the Microsoft SQL Server source and target endpoint.
|
MongoDbSettings |
getMongoDbSettings()
The settings for the MongoDB source endpoint.
|
MySQLSettings |
getMySQLSettings()
The settings for the MySQL source and target endpoint.
|
NeptuneSettings |
getNeptuneSettings()
The settings for the Amazon Neptune target endpoint.
|
OracleSettings |
getOracleSettings()
The settings for the Oracle source and target endpoint.
|
Integer |
getPort()
The port value used to access the endpoint.
|
PostgreSQLSettings |
getPostgreSQLSettings()
The settings for the PostgreSQL source and target endpoint.
|
RedisSettings |
getRedisSettings()
The settings for the Redis target endpoint.
|
RedshiftSettings |
getRedshiftSettings()
Settings for the Amazon Redshift endpoint.
|
S3Settings |
getS3Settings()
The settings for the S3 target endpoint.
|
String |
getServerName()
The name of the server at the endpoint.
|
String |
getServiceAccessRoleArn()
The Amazon Resource Name (ARN) used by the service to access the IAM role.
|
String |
getSslMode()
The SSL mode used to connect to the endpoint.
|
String |
getStatus()
The status of the endpoint.
|
SybaseSettings |
getSybaseSettings()
The settings for the SAP ASE source and target endpoint.
|
TimestreamSettings |
getTimestreamSettings()
The settings for the Amazon Timestream target endpoint.
|
String |
getUsername()
The user name used to connect to the endpoint.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCertificateArn(String certificateArn)
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
|
void |
setDatabaseName(String databaseName)
The name of the database at the endpoint.
|
void |
setDmsTransferSettings(DmsTransferSettings dmsTransferSettings)
The settings for the DMS Transfer type source.
|
void |
setDocDbSettings(DocDbSettings docDbSettings) |
void |
setDynamoDbSettings(DynamoDbSettings dynamoDbSettings)
The settings for the DynamoDB target endpoint.
|
void |
setElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
The settings for the OpenSearch source endpoint.
|
void |
setEndpointArn(String endpointArn)
The Amazon Resource Name (ARN) string that uniquely identifies the 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 |
setEngineDisplayName(String engineDisplayName)
The expanded name for the engine name.
|
void |
setEngineName(String engineName)
The database engine name.
|
void |
setExternalId(String externalId)
Value returned by a call to CreateEndpoint that can be used for cross-account validation.
|
void |
setExternalTableDefinition(String externalTableDefinition)
The external table definition.
|
void |
setExtraConnectionAttributes(String extraConnectionAttributes)
Additional connection attributes used to connect to the endpoint.
|
void |
setGcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings)
Settings in JSON format for the source GCP MySQL endpoint.
|
void |
setIBMDb2Settings(IBMDb2Settings iBMDb2Settings)
The settings for the IBM Db2 LUW source endpoint.
|
void |
setKafkaSettings(KafkaSettings kafkaSettings)
The settings for the Apache Kafka target endpoint.
|
void |
setKinesisSettings(KinesisSettings kinesisSettings)
The settings for the Amazon Kinesis target endpoint.
|
void |
setKmsKeyId(String kmsKeyId)
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
void |
setMicrosoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings)
The settings for the Microsoft SQL Server source and target endpoint.
|
void |
setMongoDbSettings(MongoDbSettings mongoDbSettings)
The settings for the MongoDB source endpoint.
|
void |
setMySQLSettings(MySQLSettings mySQLSettings)
The settings for the MySQL source and target endpoint.
|
void |
setNeptuneSettings(NeptuneSettings neptuneSettings)
The settings for the Amazon Neptune target endpoint.
|
void |
setOracleSettings(OracleSettings oracleSettings)
The settings for the Oracle source and target endpoint.
|
void |
setPort(Integer port)
The port value used to access the endpoint.
|
void |
setPostgreSQLSettings(PostgreSQLSettings postgreSQLSettings)
The settings for the PostgreSQL source and target endpoint.
|
void |
setRedisSettings(RedisSettings redisSettings)
The settings for the Redis target endpoint.
|
void |
setRedshiftSettings(RedshiftSettings redshiftSettings)
Settings for the Amazon Redshift endpoint.
|
void |
setS3Settings(S3Settings s3Settings)
The settings for the S3 target endpoint.
|
void |
setServerName(String serverName)
The name of the server at the endpoint.
|
void |
setServiceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) used by the service to access the IAM role.
|
void |
setSslMode(DmsSslModeValue sslMode)
The SSL mode used to connect to the endpoint.
|
void |
setSslMode(String sslMode)
The SSL mode used to connect to the endpoint.
|
void |
setStatus(String status)
The status of the endpoint.
|
void |
setSybaseSettings(SybaseSettings sybaseSettings)
The settings for the SAP ASE source and target endpoint.
|
void |
setTimestreamSettings(TimestreamSettings timestreamSettings)
The settings for the Amazon Timestream target endpoint.
|
void |
setUsername(String username)
The user name used to connect to the endpoint.
|
String |
toString()
Returns a string representation of this object.
|
Endpoint |
withCertificateArn(String certificateArn)
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
|
Endpoint |
withDatabaseName(String databaseName)
The name of the database at the endpoint.
|
Endpoint |
withDmsTransferSettings(DmsTransferSettings dmsTransferSettings)
The settings for the DMS Transfer type source.
|
Endpoint |
withDocDbSettings(DocDbSettings docDbSettings) |
Endpoint |
withDynamoDbSettings(DynamoDbSettings dynamoDbSettings)
The settings for the DynamoDB target endpoint.
|
Endpoint |
withElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
The settings for the OpenSearch source endpoint.
|
Endpoint |
withEndpointArn(String endpointArn)
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
|
Endpoint |
withEndpointIdentifier(String endpointIdentifier)
The database endpoint identifier.
|
Endpoint |
withEndpointType(ReplicationEndpointTypeValue endpointType)
The type of endpoint.
|
Endpoint |
withEndpointType(String endpointType)
The type of endpoint.
|
Endpoint |
withEngineDisplayName(String engineDisplayName)
The expanded name for the engine name.
|
Endpoint |
withEngineName(String engineName)
The database engine name.
|
Endpoint |
withExternalId(String externalId)
Value returned by a call to CreateEndpoint that can be used for cross-account validation.
|
Endpoint |
withExternalTableDefinition(String externalTableDefinition)
The external table definition.
|
Endpoint |
withExtraConnectionAttributes(String extraConnectionAttributes)
Additional connection attributes used to connect to the endpoint.
|
Endpoint |
withGcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings)
Settings in JSON format for the source GCP MySQL endpoint.
|
Endpoint |
withIBMDb2Settings(IBMDb2Settings iBMDb2Settings)
The settings for the IBM Db2 LUW source endpoint.
|
Endpoint |
withKafkaSettings(KafkaSettings kafkaSettings)
The settings for the Apache Kafka target endpoint.
|
Endpoint |
withKinesisSettings(KinesisSettings kinesisSettings)
The settings for the Amazon Kinesis target endpoint.
|
Endpoint |
withKmsKeyId(String kmsKeyId)
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
Endpoint |
withMicrosoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings)
The settings for the Microsoft SQL Server source and target endpoint.
|
Endpoint |
withMongoDbSettings(MongoDbSettings mongoDbSettings)
The settings for the MongoDB source endpoint.
|
Endpoint |
withMySQLSettings(MySQLSettings mySQLSettings)
The settings for the MySQL source and target endpoint.
|
Endpoint |
withNeptuneSettings(NeptuneSettings neptuneSettings)
The settings for the Amazon Neptune target endpoint.
|
Endpoint |
withOracleSettings(OracleSettings oracleSettings)
The settings for the Oracle source and target endpoint.
|
Endpoint |
withPort(Integer port)
The port value used to access the endpoint.
|
Endpoint |
withPostgreSQLSettings(PostgreSQLSettings postgreSQLSettings)
The settings for the PostgreSQL source and target endpoint.
|
Endpoint |
withRedisSettings(RedisSettings redisSettings)
The settings for the Redis target endpoint.
|
Endpoint |
withRedshiftSettings(RedshiftSettings redshiftSettings)
Settings for the Amazon Redshift endpoint.
|
Endpoint |
withS3Settings(S3Settings s3Settings)
The settings for the S3 target endpoint.
|
Endpoint |
withServerName(String serverName)
The name of the server at the endpoint.
|
Endpoint |
withServiceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) used by the service to access the IAM role.
|
Endpoint |
withSslMode(DmsSslModeValue sslMode)
The SSL mode used to connect to the endpoint.
|
Endpoint |
withSslMode(String sslMode)
The SSL mode used to connect to the endpoint.
|
Endpoint |
withStatus(String status)
The status of the endpoint.
|
Endpoint |
withSybaseSettings(SybaseSettings sybaseSettings)
The settings for the SAP ASE source and target endpoint.
|
Endpoint |
withTimestreamSettings(TimestreamSettings timestreamSettings)
The settings for the Amazon Timestream target endpoint.
|
Endpoint |
withUsername(String username)
The user name used to connect to the endpoint.
|
public void setEndpointIdentifier(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.
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 String getEndpointIdentifier()
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 Endpoint withEndpointIdentifier(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.
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 void setEndpointType(String endpointType)
The type of endpoint. Valid values are source
and target
.
endpointType
- The type of endpoint. Valid values are source
and target
.ReplicationEndpointTypeValue
public String getEndpointType()
The type of endpoint. Valid values are source
and target
.
source
and target
.ReplicationEndpointTypeValue
public Endpoint withEndpointType(String endpointType)
The type of endpoint. Valid values are source
and target
.
endpointType
- The type of endpoint. Valid values are source
and target
.ReplicationEndpointTypeValue
public void setEndpointType(ReplicationEndpointTypeValue endpointType)
The type of endpoint. Valid values are source
and target
.
endpointType
- The type of endpoint. Valid values are source
and target
.ReplicationEndpointTypeValue
public Endpoint withEndpointType(ReplicationEndpointTypeValue endpointType)
The type of endpoint. Valid values are source
and target
.
endpointType
- The type of endpoint. Valid values are source
and target
.ReplicationEndpointTypeValue
public void setEngineName(String engineName)
The database engine name. Valid values, depending on the EndpointType, include "mysql"
,
"oracle"
, "postgres"
, "mariadb"
, "aurora"
,
"aurora-postgresql"
, "redshift"
, "redshift-serverless"
, "s3"
,
"db2"
, "db2-zos"
, "azuredb"
, "sybase"
,
"dynamodb"
, "mongodb"
, "kinesis"
, "kafka"
,
"elasticsearch"
, "documentdb"
, "sqlserver"
, "neptune"
, and
"babelfish"
.
engineName
- The database engine name. Valid values, depending on the EndpointType, include "mysql"
,
"oracle"
, "postgres"
, "mariadb"
, "aurora"
,
"aurora-postgresql"
, "redshift"
, "redshift-serverless"
,
"s3"
, "db2"
, "db2-zos"
, "azuredb"
,
"sybase"
, "dynamodb"
, "mongodb"
, "kinesis"
,
"kafka"
, "elasticsearch"
, "documentdb"
, "sqlserver"
,
"neptune"
, and "babelfish"
.public String getEngineName()
The database engine name. Valid values, depending on the EndpointType, include "mysql"
,
"oracle"
, "postgres"
, "mariadb"
, "aurora"
,
"aurora-postgresql"
, "redshift"
, "redshift-serverless"
, "s3"
,
"db2"
, "db2-zos"
, "azuredb"
, "sybase"
,
"dynamodb"
, "mongodb"
, "kinesis"
, "kafka"
,
"elasticsearch"
, "documentdb"
, "sqlserver"
, "neptune"
, and
"babelfish"
.
"mysql"
,
"oracle"
, "postgres"
, "mariadb"
, "aurora"
,
"aurora-postgresql"
, "redshift"
, "redshift-serverless"
,
"s3"
, "db2"
, "db2-zos"
, "azuredb"
,
"sybase"
, "dynamodb"
, "mongodb"
, "kinesis"
,
"kafka"
, "elasticsearch"
, "documentdb"
, "sqlserver"
,
"neptune"
, and "babelfish"
.public Endpoint withEngineName(String engineName)
The database engine name. Valid values, depending on the EndpointType, include "mysql"
,
"oracle"
, "postgres"
, "mariadb"
, "aurora"
,
"aurora-postgresql"
, "redshift"
, "redshift-serverless"
, "s3"
,
"db2"
, "db2-zos"
, "azuredb"
, "sybase"
,
"dynamodb"
, "mongodb"
, "kinesis"
, "kafka"
,
"elasticsearch"
, "documentdb"
, "sqlserver"
, "neptune"
, and
"babelfish"
.
engineName
- The database engine name. Valid values, depending on the EndpointType, include "mysql"
,
"oracle"
, "postgres"
, "mariadb"
, "aurora"
,
"aurora-postgresql"
, "redshift"
, "redshift-serverless"
,
"s3"
, "db2"
, "db2-zos"
, "azuredb"
,
"sybase"
, "dynamodb"
, "mongodb"
, "kinesis"
,
"kafka"
, "elasticsearch"
, "documentdb"
, "sqlserver"
,
"neptune"
, and "babelfish"
.public void setEngineDisplayName(String engineDisplayName)
The expanded name for the engine name. For example, if the EngineName
parameter is "aurora", this
value would be "Amazon Aurora MySQL".
engineDisplayName
- The expanded name for the engine name. For example, if the EngineName
parameter is "aurora",
this value would be "Amazon Aurora MySQL".public String getEngineDisplayName()
The expanded name for the engine name. For example, if the EngineName
parameter is "aurora", this
value would be "Amazon Aurora MySQL".
EngineName
parameter is "aurora",
this value would be "Amazon Aurora MySQL".public Endpoint withEngineDisplayName(String engineDisplayName)
The expanded name for the engine name. For example, if the EngineName
parameter is "aurora", this
value would be "Amazon Aurora MySQL".
engineDisplayName
- The expanded name for the engine name. For example, if the EngineName
parameter is "aurora",
this value would be "Amazon Aurora MySQL".public void setUsername(String username)
The user name used to connect to the endpoint.
username
- The user name used to connect to the endpoint.public String getUsername()
The user name used to connect to the endpoint.
public Endpoint withUsername(String username)
The user name used to connect to the endpoint.
username
- The user name used to connect to the endpoint.public void setServerName(String serverName)
The name of the server at the endpoint.
serverName
- The name of the server at the endpoint.public String getServerName()
The name of the server at the endpoint.
public Endpoint withServerName(String serverName)
The name of the server at the endpoint.
serverName
- The name of the server at the endpoint.public void setPort(Integer port)
The port value used to access the endpoint.
port
- The port value used to access the endpoint.public Integer getPort()
The port value used to access the endpoint.
public Endpoint withPort(Integer port)
The port value used to access the endpoint.
port
- The port value used to access the endpoint.public void setDatabaseName(String databaseName)
The name of the database at the endpoint.
databaseName
- The name of the database at the endpoint.public String getDatabaseName()
The name of the database at the endpoint.
public Endpoint withDatabaseName(String databaseName)
The name of the database at the endpoint.
databaseName
- The name of the database at the endpoint.public void setExtraConnectionAttributes(String extraConnectionAttributes)
Additional connection attributes used to connect to the endpoint.
extraConnectionAttributes
- Additional connection attributes used to connect to the endpoint.public String getExtraConnectionAttributes()
Additional connection attributes used to connect to the endpoint.
public Endpoint withExtraConnectionAttributes(String extraConnectionAttributes)
Additional connection attributes used to connect to the endpoint.
extraConnectionAttributes
- Additional connection attributes used to connect to the endpoint.public void setStatus(String status)
The status of the endpoint.
status
- The status of the endpoint.public String getStatus()
The status of the endpoint.
public Endpoint withStatus(String status)
The status of the endpoint.
status
- The status of the endpoint.public void setKmsKeyId(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.
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.
public String getKmsKeyId()
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 Endpoint withKmsKeyId(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.
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.
public void setEndpointArn(String endpointArn)
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.public String getEndpointArn()
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
public Endpoint withEndpointArn(String endpointArn)
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.public void setCertificateArn(String certificateArn)
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
certificateArn
- The Amazon Resource Name (ARN) used for SSL connection to the endpoint.public String getCertificateArn()
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
public Endpoint withCertificateArn(String certificateArn)
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
certificateArn
- The Amazon Resource Name (ARN) used for SSL connection to the endpoint.public void setSslMode(String sslMode)
The SSL mode used to connect to the endpoint. The default value is none
.
sslMode
- The SSL mode used to connect to the endpoint. The default value is none
.DmsSslModeValue
public String getSslMode()
The SSL mode used to connect to the endpoint. The default value is none
.
none
.DmsSslModeValue
public Endpoint withSslMode(String sslMode)
The SSL mode used to connect to the endpoint. The default value is none
.
sslMode
- The SSL mode used to connect to the endpoint. The default value is none
.DmsSslModeValue
public void setSslMode(DmsSslModeValue sslMode)
The SSL mode used to connect to the endpoint. The default value is none
.
sslMode
- The SSL mode used to connect to the endpoint. The default value is none
.DmsSslModeValue
public Endpoint withSslMode(DmsSslModeValue sslMode)
The SSL mode used to connect to the endpoint. The default value is none
.
sslMode
- The SSL mode used to connect to the endpoint. The default value is none
.DmsSslModeValue
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.
serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.public String getServiceAccessRoleArn()
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.
iam:PassRole
action.public Endpoint withServiceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.
serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole
action.public void setExternalTableDefinition(String externalTableDefinition)
The external table definition.
externalTableDefinition
- The external table definition.public String getExternalTableDefinition()
The external table definition.
public Endpoint withExternalTableDefinition(String externalTableDefinition)
The external table definition.
externalTableDefinition
- The external table definition.public void setExternalId(String externalId)
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
externalId
- Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a
subsequent call to CreateEndpoint to create the endpoint with a cross-account.public String getExternalId()
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
public Endpoint withExternalId(String externalId)
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
externalId
- Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a
subsequent call to CreateEndpoint to create the endpoint with a cross-account.public void setDynamoDbSettings(DynamoDbSettings dynamoDbSettings)
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings
structure.
dynamoDbSettings
- The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings
structure.public DynamoDbSettings getDynamoDbSettings()
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings
structure.
DynamoDBSettings
structure.public Endpoint withDynamoDbSettings(DynamoDbSettings dynamoDbSettings)
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings
structure.
dynamoDbSettings
- The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings
structure.public void setS3Settings(S3Settings s3Settings)
The settings for the S3 target endpoint. For more information, see the S3Settings
structure.
s3Settings
- The settings for the S3 target endpoint. For more information, see the S3Settings
structure.public S3Settings getS3Settings()
The settings for the S3 target endpoint. For more information, see the S3Settings
structure.
S3Settings
structure.public Endpoint withS3Settings(S3Settings s3Settings)
The settings for the S3 target endpoint. For more information, see the S3Settings
structure.
s3Settings
- The settings for the S3 target endpoint. For more information, see the S3Settings
structure.public void setDmsTransferSettings(DmsTransferSettings dmsTransferSettings)
The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
dmsTransferSettings
- The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings
structure.public DmsTransferSettings getDmsTransferSettings()
The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
public Endpoint withDmsTransferSettings(DmsTransferSettings dmsTransferSettings)
The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
dmsTransferSettings
- The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings
structure.public void setMongoDbSettings(MongoDbSettings mongoDbSettings)
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.
mongoDbSettings
- The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.public MongoDbSettings getMongoDbSettings()
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.
MongoDbSettings
structure.public Endpoint withMongoDbSettings(MongoDbSettings mongoDbSettings)
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.
mongoDbSettings
- The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.public void setKinesisSettings(KinesisSettings kinesisSettings)
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings
structure.
kinesisSettings
- The settings for the Amazon Kinesis target endpoint. For more information, see the
KinesisSettings
structure.public KinesisSettings getKinesisSettings()
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings
structure.
KinesisSettings
structure.public Endpoint withKinesisSettings(KinesisSettings kinesisSettings)
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings
structure.
kinesisSettings
- The settings for the Amazon Kinesis target endpoint. For more information, see the
KinesisSettings
structure.public void setKafkaSettings(KafkaSettings kafkaSettings)
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings
structure.
kafkaSettings
- The settings for the Apache Kafka target endpoint. For more information, see the
KafkaSettings
structure.public KafkaSettings getKafkaSettings()
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings
structure.
KafkaSettings
structure.public Endpoint withKafkaSettings(KafkaSettings kafkaSettings)
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings
structure.
kafkaSettings
- The settings for the Apache Kafka target endpoint. For more information, see the
KafkaSettings
structure.public void setElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings
structure.
elasticsearchSettings
- The settings for the OpenSearch source endpoint. For more information, see the
ElasticsearchSettings
structure.public ElasticsearchSettings getElasticsearchSettings()
The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings
structure.
ElasticsearchSettings
structure.public Endpoint withElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings
structure.
elasticsearchSettings
- The settings for the OpenSearch source endpoint. For more information, see the
ElasticsearchSettings
structure.public void setNeptuneSettings(NeptuneSettings neptuneSettings)
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings
structure.
neptuneSettings
- The settings for the Amazon Neptune target endpoint. For more information, see the
NeptuneSettings
structure.public NeptuneSettings getNeptuneSettings()
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings
structure.
NeptuneSettings
structure.public Endpoint withNeptuneSettings(NeptuneSettings neptuneSettings)
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings
structure.
neptuneSettings
- The settings for the Amazon Neptune target endpoint. For more information, see the
NeptuneSettings
structure.public void setRedshiftSettings(RedshiftSettings redshiftSettings)
Settings for the Amazon Redshift endpoint.
redshiftSettings
- Settings for the Amazon Redshift endpoint.public RedshiftSettings getRedshiftSettings()
Settings for the Amazon Redshift endpoint.
public Endpoint withRedshiftSettings(RedshiftSettings redshiftSettings)
Settings for the Amazon Redshift endpoint.
redshiftSettings
- Settings for the Amazon Redshift endpoint.public void setPostgreSQLSettings(PostgreSQLSettings postgreSQLSettings)
The settings for the PostgreSQL source and target endpoint. For more information, see the
PostgreSQLSettings
structure.
postgreSQLSettings
- The settings for the PostgreSQL source and target endpoint. For more information, see the
PostgreSQLSettings
structure.public PostgreSQLSettings getPostgreSQLSettings()
The settings for the PostgreSQL source and target endpoint. For more information, see the
PostgreSQLSettings
structure.
PostgreSQLSettings
structure.public Endpoint withPostgreSQLSettings(PostgreSQLSettings postgreSQLSettings)
The settings for the PostgreSQL source and target endpoint. For more information, see the
PostgreSQLSettings
structure.
postgreSQLSettings
- The settings for the PostgreSQL source and target endpoint. For more information, see the
PostgreSQLSettings
structure.public void setMySQLSettings(MySQLSettings mySQLSettings)
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings
structure.
mySQLSettings
- The settings for the MySQL source and target endpoint. For more information, see the
MySQLSettings
structure.public MySQLSettings getMySQLSettings()
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings
structure.
MySQLSettings
structure.public Endpoint withMySQLSettings(MySQLSettings mySQLSettings)
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings
structure.
mySQLSettings
- The settings for the MySQL source and target endpoint. For more information, see the
MySQLSettings
structure.public void setOracleSettings(OracleSettings oracleSettings)
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings
structure.
oracleSettings
- The settings for the Oracle source and target endpoint. For more information, see the
OracleSettings
structure.public OracleSettings getOracleSettings()
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings
structure.
OracleSettings
structure.public Endpoint withOracleSettings(OracleSettings oracleSettings)
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings
structure.
oracleSettings
- The settings for the Oracle source and target endpoint. For more information, see the
OracleSettings
structure.public void setSybaseSettings(SybaseSettings sybaseSettings)
The settings for the SAP ASE source and target endpoint. For more information, see the
SybaseSettings
structure.
sybaseSettings
- The settings for the SAP ASE source and target endpoint. For more information, see the
SybaseSettings
structure.public SybaseSettings getSybaseSettings()
The settings for the SAP ASE source and target endpoint. For more information, see the
SybaseSettings
structure.
SybaseSettings
structure.public Endpoint withSybaseSettings(SybaseSettings sybaseSettings)
The settings for the SAP ASE source and target endpoint. For more information, see the
SybaseSettings
structure.
sybaseSettings
- The settings for the SAP ASE source and target endpoint. For more information, see the
SybaseSettings
structure.public void setMicrosoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings)
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the
MicrosoftSQLServerSettings
structure.
microsoftSQLServerSettings
- The settings for the Microsoft SQL Server source and target endpoint. For more information, see the
MicrosoftSQLServerSettings
structure.public MicrosoftSQLServerSettings getMicrosoftSQLServerSettings()
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the
MicrosoftSQLServerSettings
structure.
MicrosoftSQLServerSettings
structure.public Endpoint withMicrosoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings)
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the
MicrosoftSQLServerSettings
structure.
microsoftSQLServerSettings
- The settings for the Microsoft SQL Server source and target endpoint. For more information, see the
MicrosoftSQLServerSettings
structure.public void setIBMDb2Settings(IBMDb2Settings iBMDb2Settings)
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings
structure.
iBMDb2Settings
- The settings for the IBM Db2 LUW source endpoint. For more information, see the
IBMDb2Settings
structure.public IBMDb2Settings getIBMDb2Settings()
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings
structure.
IBMDb2Settings
structure.public Endpoint withIBMDb2Settings(IBMDb2Settings iBMDb2Settings)
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings
structure.
iBMDb2Settings
- The settings for the IBM Db2 LUW source endpoint. For more information, see the
IBMDb2Settings
structure.public void setDocDbSettings(DocDbSettings docDbSettings)
docDbSettings
- public DocDbSettings getDocDbSettings()
public Endpoint withDocDbSettings(DocDbSettings docDbSettings)
docDbSettings
- public void setRedisSettings(RedisSettings redisSettings)
The settings for the Redis target endpoint. For more information, see the RedisSettings
structure.
redisSettings
- The settings for the Redis target endpoint. For more information, see the RedisSettings
structure.public RedisSettings getRedisSettings()
The settings for the Redis target endpoint. For more information, see the RedisSettings
structure.
RedisSettings
structure.public Endpoint withRedisSettings(RedisSettings redisSettings)
The settings for the Redis target endpoint. For more information, see the RedisSettings
structure.
redisSettings
- The settings for the Redis target endpoint. For more information, see the RedisSettings
structure.public void setGcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings)
Settings in JSON format for the source GCP MySQL endpoint.
gcpMySQLSettings
- Settings in JSON format for the source GCP MySQL endpoint.public GcpMySQLSettings getGcpMySQLSettings()
Settings in JSON format for the source GCP MySQL endpoint.
public Endpoint withGcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings)
Settings in JSON format for the source GCP MySQL endpoint.
gcpMySQLSettings
- Settings in JSON format for the source GCP MySQL endpoint.public void setTimestreamSettings(TimestreamSettings timestreamSettings)
The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.
timestreamSettings
- The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.public TimestreamSettings getTimestreamSettings()
The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.
TimestreamSettings
structure.public Endpoint withTimestreamSettings(TimestreamSettings timestreamSettings)
The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.
timestreamSettings
- The settings for the Amazon Timestream target endpoint. For more information, see the
TimestreamSettings
structure.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.