Endpoint (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.Endpoint

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Endpoint()

Constructors
Constructor and Description
`Endpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
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 in JSON format for the DMS transfer type of source endpoint.
`DynamoDbSettings`	`getDynamoDbSettings()` The settings for the target DynamoDB database.
`ElasticsearchSettings`	`getElasticsearchSettings()` The settings for the Elasticsearch 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.
`KinesisSettings`	`getKinesisSettings()` The settings for the Amazon Kinesis source endpoint.
`String`	`getKmsKeyId()` The AWS KMS key identifier that is used to encrypt the content on the replication instance.
`MongoDbSettings`	`getMongoDbSettings()` The settings for the MongoDB source endpoint.
`Integer`	`getPort()` The port value used to access the 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 access IAM role.
`String`	`getSslMode()` The SSL mode used to connect to the endpoint.
`String`	`getStatus()` The status of the 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 in JSON format for the DMS transfer type of source endpoint.
`void`	`setDynamoDbSettings(DynamoDbSettings dynamoDbSettings)` The settings for the target DynamoDB database.
`void`	`setElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)` The settings for the Elasticsearch 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`	`setKinesisSettings(KinesisSettings kinesisSettings)` The settings for the Amazon Kinesis source endpoint.
`void`	`setKmsKeyId(String kmsKeyId)` The AWS KMS key identifier that is used to encrypt the content on the replication instance.
`void`	`setMongoDbSettings(MongoDbSettings mongoDbSettings)` The settings for the MongoDB source endpoint.
`void`	`setPort(Integer port)` The port value used to access the 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 access 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`	`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 in JSON format for the DMS transfer type of source endpoint.
`Endpoint`	`withDynamoDbSettings(DynamoDbSettings dynamoDbSettings)` The settings for the target DynamoDB database.
`Endpoint`	`withElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)` The settings for the Elasticsearch 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`	`withKinesisSettings(KinesisSettings kinesisSettings)` The settings for the Amazon Kinesis source endpoint.
`Endpoint`	`withKmsKeyId(String kmsKeyId)` The AWS KMS key identifier that is used to encrypt the content on the replication instance.
`Endpoint`	`withMongoDbSettings(MongoDbSettings mongoDbSettings)` The settings for the MongoDB source endpoint.
`Endpoint`	`withPort(Integer port)` The port value used to access the 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 access 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`	`withUsername(String username)` The user name used to connect to the endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Endpoint
```
public Endpoint()
```
- 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 Endpoint 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 Endpoint 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 Endpoint 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 database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
    
    Parameters:
    
    engineName - The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
  - getEngineName
```
public String getEngineName()
```
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
    
    Returns:
    
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
  - withEngineName
```
public Endpoint withEngineName(String engineName)
```
    The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
    
    Parameters:
    
    engineName - The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineDisplayName
```
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."
    
    Parameters:
    
    engineDisplayName - The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
  - getEngineDisplayName
```
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."
    
    Returns:
    
    The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
  - withEngineDisplayName
```
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."
    
    Parameters:
    
    engineDisplayName - The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The user name used to connect to the endpoint.
    
    Parameters:
    
    username - The user name used to connect to the endpoint.
  - getUsername
```
public String getUsername()
```
    The user name used to connect to the endpoint.
    
    Returns:
    
    The user name used to connect to the endpoint.
  - withUsername
```
public Endpoint withUsername(String username)
```
    The user name used to connect to the endpoint.
    
    Parameters:
    
    username - The user name used to connect to the endpoint.
    
    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 at the endpoint.
    
    Parameters:
    
    serverName - The name of the server at the endpoint.
  - getServerName
```
public String getServerName()
```
    The name of the server at the endpoint.
    
    Returns:
    
    The name of the server at the endpoint.
  - withServerName
```
public Endpoint withServerName(String serverName)
```
    The name of the server at the endpoint.
    
    Parameters:
    
    serverName - The name of the server at the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port value used to access the endpoint.
    
    Parameters:
    
    port - The port value used to access the endpoint.
  - getPort
```
public Integer getPort()
```
    The port value used to access the endpoint.
    
    Returns:
    
    The port value used to access the endpoint.
  - withPort
```
public Endpoint withPort(Integer port)
```
    The port value used to access the endpoint.
    
    Parameters:
    
    port - The port value used to access the endpoint.
    
    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 database at the endpoint.
    
    Parameters:
    
    databaseName - The name of the database at the endpoint.
  - getDatabaseName
```
public String getDatabaseName()
```
    The name of the database at the endpoint.
    
    Returns:
    
    The name of the database at the endpoint.
  - withDatabaseName
```
public Endpoint withDatabaseName(String databaseName)
```
    The name of the database at the endpoint.
    
    Parameters:
    
    databaseName - The name of the database at the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExtraConnectionAttributes
```
public void setExtraConnectionAttributes(String extraConnectionAttributes)
```
    Additional connection attributes used to connect to the endpoint.
    
    Parameters:
    
    extraConnectionAttributes - Additional connection attributes used to connect to the endpoint.
  - getExtraConnectionAttributes
```
public String getExtraConnectionAttributes()
```
    Additional connection attributes used to connect to the endpoint.
    
    Returns:
    
    Additional connection attributes used to connect to the endpoint.
  - withExtraConnectionAttributes
```
public Endpoint withExtraConnectionAttributes(String extraConnectionAttributes)
```
    Additional connection attributes used to connect to the endpoint.
    
    Parameters:
    
    extraConnectionAttributes - Additional connection attributes used to connect to the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the endpoint.
    
    Parameters:
    
    status - The status of the endpoint.
  - getStatus
```
public String getStatus()
```
    The status of the endpoint.
    
    Returns:
    
    The status of the endpoint.
  - withStatus
```
public Endpoint withStatus(String status)
```
    The status of the endpoint.
    
    Parameters:
    
    status - The status of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
    
    Parameters:
    
    kmsKeyId - The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
    
    Returns:
    
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
  - withKmsKeyId
```
public Endpoint withKmsKeyId(String kmsKeyId)
```
    The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
    
    Parameters:
    
    kmsKeyId - The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointArn
```
public void setEndpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
  - getEndpointArn
```
public String getEndpointArn()
```
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
  - withEndpointArn
```
public Endpoint withEndpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies 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 Name (ARN) used for SSL connection to the endpoint.
    
    Parameters:
    
    certificateArn - The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
  - getCertificateArn
```
public String getCertificateArn()
```
    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
  - withCertificateArn
```
public Endpoint withCertificateArn(String certificateArn)
```
    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
    
    Parameters:
    
    certificateArn - The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSslMode
```
public void setSslMode(String sslMode)
```
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Parameters:
    
    sslMode - The SSL mode used to connect to the endpoint.
    
    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 used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Returns:
    
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    See Also:
    
    DmsSslModeValue
  - withSslMode
```
public Endpoint withSslMode(String sslMode)
```
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Parameters:
    
    sslMode - The SSL mode used to connect to the endpoint.
    
    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 used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Parameters:
    
    sslMode - The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    See Also:
    
    DmsSslModeValue
  - withSslMode
```
public Endpoint withSslMode(DmsSslModeValue sslMode)
```
    The SSL mode used to connect to the endpoint.
    
    SSL mode can be one of four values: none, require, verify-ca, verify-full.
    
    The default value is none.
    
    Parameters:
    
    sslMode - The SSL mode used to connect to the endpoint.
    
    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
  - setServiceAccessRoleArn
```
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Returns:
    
    The Amazon Resource Name (ARN) used by the service access IAM role.
  - withServiceAccessRoleArn
```
public Endpoint withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalTableDefinition
```
public void setExternalTableDefinition(String externalTableDefinition)
```
    The external table definition.
    
    Parameters:
    
    externalTableDefinition - The external table definition.
  - getExternalTableDefinition
```
public String getExternalTableDefinition()
```
    The external table definition.
    
    Returns:
    
    The external table definition.
  - withExternalTableDefinition
```
public Endpoint withExternalTableDefinition(String externalTableDefinition)
```
    The external table definition.
    
    Parameters:
    
    externalTableDefinition - The external table definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalId
```
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.
    
    Parameters:
    
    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.
  - getExternalId
```
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.
    
    Returns:
    
    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.
  - withExternalId
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDynamoDbSettings
```
public void setDynamoDbSettings(DynamoDbSettings dynamoDbSettings)
```
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    
    Parameters:
    
    dynamoDbSettings - The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
  - getDynamoDbSettings
```
public DynamoDbSettings getDynamoDbSettings()
```
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    
    Returns:
    
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
  - withDynamoDbSettings
```
public Endpoint withDynamoDbSettings(DynamoDbSettings dynamoDbSettings)
```
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    
    Parameters:
    
    dynamoDbSettings - The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Settings
```
public void setS3Settings(S3Settings s3Settings)
```
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    
    Parameters:
    
    s3Settings - The settings for the S3 target endpoint. For more information, see the S3Settings structure.
  - getS3Settings
```
public S3Settings getS3Settings()
```
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    
    Returns:
    
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
  - withS3Settings
```
public Endpoint withS3Settings(S3Settings s3Settings)
```
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    
    Parameters:
    
    s3Settings - The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDmsTransferSettings
```
public void setDmsTransferSettings(DmsTransferSettings dmsTransferSettings)
```
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    - bucketName - The name of the S3 bucket to use.
    - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    Parameters:
    dmsTransferSettings - The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    
    serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    
    bucketName - The name of the S3 bucket to use.
    
    compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
  - getDmsTransferSettings
```
public DmsTransferSettings getDmsTransferSettings()
```
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    - bucketName - The name of the S3 bucket to use.
    - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    Returns:
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    
    serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    
    bucketName - The name of the S3 bucket to use.
    
    compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
  - withDmsTransferSettings
```
public Endpoint withDmsTransferSettings(DmsTransferSettings dmsTransferSettings)
```
    The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    - serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    - bucketName - The name of the S3 bucket to use.
    - compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    Parameters:
    dmsTransferSettings - The settings in JSON format for the DMS transfer type of source endpoint.
    
    Possible attributes include the following:
    
    serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
    
    bucketName - The name of the S3 bucket to use.
    
    compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.
    
    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
    
    JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMongoDbSettings
```
public void setMongoDbSettings(MongoDbSettings mongoDbSettings)
```
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    
    Parameters:
    
    mongoDbSettings - The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
  - getMongoDbSettings
```
public MongoDbSettings getMongoDbSettings()
```
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    
    Returns:
    
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
  - withMongoDbSettings
```
public Endpoint withMongoDbSettings(MongoDbSettings mongoDbSettings)
```
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    
    Parameters:
    
    mongoDbSettings - The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisSettings
```
public void setKinesisSettings(KinesisSettings kinesisSettings)
```
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    
    Parameters:
    
    kinesisSettings - The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
  - getKinesisSettings
```
public KinesisSettings getKinesisSettings()
```
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    
    Returns:
    
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
  - withKinesisSettings
```
public Endpoint withKinesisSettings(KinesisSettings kinesisSettings)
```
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    
    Parameters:
    
    kinesisSettings - The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setElasticsearchSettings
```
public void setElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
```
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    
    Parameters:
    
    elasticsearchSettings - The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
  - getElasticsearchSettings
```
public ElasticsearchSettings getElasticsearchSettings()
```
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    
    Returns:
    
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
  - withElasticsearchSettings
```
public Endpoint withElasticsearchSettings(ElasticsearchSettings elasticsearchSettings)
```
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    
    Parameters:
    
    elasticsearchSettings - The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRedshiftSettings
```
public void setRedshiftSettings(RedshiftSettings redshiftSettings)
```
    Settings for the Amazon Redshift endpoint
    
    Parameters:
    
    redshiftSettings - Settings for the Amazon Redshift endpoint
  - getRedshiftSettings
```
public RedshiftSettings getRedshiftSettings()
```
    Settings for the Amazon Redshift endpoint
    
    Returns:
    
    Settings for the Amazon Redshift endpoint
  - withRedshiftSettings
```
public Endpoint withRedshiftSettings(RedshiftSettings redshiftSettings)
```
    Settings for the Amazon Redshift endpoint
    
    Parameters:
    
    redshiftSettings - Settings for the Amazon Redshift endpoint
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 Endpoint clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Endpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Endpoint

Method Detail

setEndpointIdentifier

getEndpointIdentifier

withEndpointIdentifier

setEndpointType

getEndpointType

withEndpointType

setEndpointType

withEndpointType

setEngineName

getEngineName

withEngineName

setEngineDisplayName

getEngineDisplayName

withEngineDisplayName

setUsername

getUsername

withUsername

setServerName

getServerName

withServerName

setPort

getPort

withPort

setDatabaseName

getDatabaseName

withDatabaseName

setExtraConnectionAttributes

getExtraConnectionAttributes

withExtraConnectionAttributes

setStatus

getStatus

withStatus

setKmsKeyId

getKmsKeyId

withKmsKeyId

setEndpointArn

getEndpointArn

withEndpointArn

setCertificateArn

getCertificateArn

withCertificateArn

setSslMode

getSslMode

withSslMode

setSslMode

withSslMode

setServiceAccessRoleArn

getServiceAccessRoleArn

withServiceAccessRoleArn

setExternalTableDefinition

getExternalTableDefinition

withExternalTableDefinition

setExternalId

getExternalId

withExternalId

setDynamoDbSettings

getDynamoDbSettings

withDynamoDbSettings

setS3Settings

getS3Settings

withS3Settings

setDmsTransferSettings

getDmsTransferSettings

withDmsTransferSettings

setMongoDbSettings

getMongoDbSettings

withMongoDbSettings

setKinesisSettings

getKinesisSettings

withKinesisSettings

setElasticsearchSettings

getElasticsearchSettings