Endpoint.Builder (AWS SDK for Java

All Superinterfaces:

Buildable, CopyableBuilder<Endpoint.Builder,Endpoint>, SdkBuilder<Endpoint.Builder,Endpoint>, SdkPojo

Enclosing class:

Endpoint
```
public static interface Endpoint.Builder
extends SdkPojo, CopyableBuilder<Endpoint.Builder,Endpoint>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Endpoint.Builder`	`certificateArn(String certificateArn)` The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
`Endpoint.Builder`	`databaseName(String databaseName)` The name of the database at the endpoint.
`default Endpoint.Builder`	`dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)` The settings in JSON format for the DMS transfer type of source endpoint.
`Endpoint.Builder`	`dmsTransferSettings(DmsTransferSettings dmsTransferSettings)` The settings in JSON format for the DMS transfer type of source endpoint.
`default Endpoint.Builder`	`dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)` The settings for the target DynamoDB database.
`Endpoint.Builder`	`dynamoDbSettings(DynamoDbSettings dynamoDbSettings)` The settings for the target DynamoDB database.
`default Endpoint.Builder`	`elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings)` The settings for the Elasticsearch source endpoint.
`Endpoint.Builder`	`elasticsearchSettings(ElasticsearchSettings elasticsearchSettings)` The settings for the Elasticsearch source endpoint.
`Endpoint.Builder`	`endpointArn(String endpointArn)` The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
`Endpoint.Builder`	`endpointIdentifier(String endpointIdentifier)` The database endpoint identifier.
`Endpoint.Builder`	`endpointType(ReplicationEndpointTypeValue endpointType)` The type of endpoint.
`Endpoint.Builder`	`endpointType(String endpointType)` The type of endpoint.
`Endpoint.Builder`	`engineDisplayName(String engineDisplayName)` The expanded name for the engine name.
`Endpoint.Builder`	`engineName(String engineName)` The database engine name.
`Endpoint.Builder`	`externalId(String externalId)` Value returned by a call to CreateEndpoint that can be used for cross-account validation.
`Endpoint.Builder`	`externalTableDefinition(String externalTableDefinition)` The external table definition.
`Endpoint.Builder`	`extraConnectionAttributes(String extraConnectionAttributes)` Additional connection attributes used to connect to the endpoint.
`default Endpoint.Builder`	`kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)` The settings for the Amazon Kinesis source endpoint.
`Endpoint.Builder`	`kinesisSettings(KinesisSettings kinesisSettings)` The settings for the Amazon Kinesis source endpoint.
`Endpoint.Builder`	`kmsKeyId(String kmsKeyId)` The AWS KMS key identifier that is used to encrypt the content on the replication instance.
`default Endpoint.Builder`	`mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)` The settings for the MongoDB source endpoint.
`Endpoint.Builder`	`mongoDbSettings(MongoDbSettings mongoDbSettings)` The settings for the MongoDB source endpoint.
`Endpoint.Builder`	`port(Integer port)` The port value used to access the endpoint.
`default Endpoint.Builder`	`s3Settings(Consumer<S3Settings.Builder> s3Settings)` The settings for the S3 target endpoint.
`Endpoint.Builder`	`s3Settings(S3Settings s3Settings)` The settings for the S3 target endpoint.
`Endpoint.Builder`	`serverName(String serverName)` The name of the server at the endpoint.
`Endpoint.Builder`	`serviceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) used by the service access IAM role.
`Endpoint.Builder`	`sslMode(DmsSslModeValue sslMode)` The SSL mode used to connect to the endpoint.
`Endpoint.Builder`	`sslMode(String sslMode)` The SSL mode used to connect to the endpoint.
`Endpoint.Builder`	`status(String status)` The status of the endpoint.
`Endpoint.Builder`	`username(String username)` The user name used to connect to the endpoint.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - endpointIdentifier
```
Endpoint.Builder endpointIdentifier(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.
  - endpointType
```
Endpoint.Builder endpointType(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, ReplicationEndpointTypeValue
  - endpointType
```
Endpoint.Builder endpointType(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, ReplicationEndpointTypeValue
  - engineName
```
Endpoint.Builder engineName(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.
  - engineDisplayName
```
Endpoint.Builder engineDisplayName(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.
  - username
```
Endpoint.Builder username(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.
  - serverName
```
Endpoint.Builder serverName(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.
  - port
```
Endpoint.Builder port(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.
  - databaseName
```
Endpoint.Builder databaseName(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.
  - extraConnectionAttributes
```
Endpoint.Builder extraConnectionAttributes(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.
  - status
```
Endpoint.Builder status(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.
  - kmsKeyId
```
Endpoint.Builder kmsKeyId(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.
  - endpointArn
```
Endpoint.Builder endpointArn(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.
  - certificateArn
```
Endpoint.Builder certificateArn(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.
  - sslMode
```
Endpoint.Builder sslMode(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, DmsSslModeValue
  - sslMode
```
Endpoint.Builder sslMode(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, DmsSslModeValue
  - serviceAccessRoleArn
```
Endpoint.Builder serviceAccessRoleArn(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.
  - externalTableDefinition
```
Endpoint.Builder externalTableDefinition(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.
  - externalId
```
Endpoint.Builder externalId(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.
  - dynamoDbSettings
```
Endpoint.Builder dynamoDbSettings(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.
  - dynamoDbSettings
```
default Endpoint.Builder dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)
```
    The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
    This is a convenience that creates an instance of the DynamoDbSettings.Builder avoiding the need to create one manually via DynamoDbSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dynamoDbSettings(DynamoDbSettings).
    
    Parameters:
    
    dynamoDbSettings - a consumer that will call methods on DynamoDbSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    dynamoDbSettings(DynamoDbSettings)
  - s3Settings
```
Endpoint.Builder s3Settings(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.
  - s3Settings
```
default Endpoint.Builder s3Settings(Consumer<S3Settings.Builder> s3Settings)
```
    The settings for the S3 target endpoint. For more information, see the S3Settings structure.
    This is a convenience that creates an instance of the S3Settings.Builder avoiding the need to create one manually via S3Settings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Settings(S3Settings).
    
    Parameters:
    
    s3Settings - a consumer that will call methods on S3Settings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    s3Settings(S3Settings)
  - dmsTransferSettings
```
Endpoint.Builder dmsTransferSettings(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.
  - dmsTransferSettings
```
default Endpoint.Builder dmsTransferSettings(Consumer<DmsTransferSettings.Builder> 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" }
    This is a convenience that creates an instance of the DmsTransferSettings.Builder avoiding the need to create one manually via DmsTransferSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dmsTransferSettings(DmsTransferSettings).
    Parameters:
    
    dmsTransferSettings - a consumer that will call methods on DmsTransferSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    dmsTransferSettings(DmsTransferSettings)
  - mongoDbSettings
```
Endpoint.Builder mongoDbSettings(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.
  - mongoDbSettings
```
default Endpoint.Builder mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)
```
    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
    This is a convenience that creates an instance of the MongoDbSettings.Builder avoiding the need to create one manually via MongoDbSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mongoDbSettings(MongoDbSettings).
    
    Parameters:
    
    mongoDbSettings - a consumer that will call methods on MongoDbSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    mongoDbSettings(MongoDbSettings)
  - kinesisSettings
```
Endpoint.Builder kinesisSettings(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.
  - kinesisSettings
```
default Endpoint.Builder kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)
```
    The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
    This is a convenience that creates an instance of the KinesisSettings.Builder avoiding the need to create one manually via KinesisSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisSettings(KinesisSettings).
    
    Parameters:
    
    kinesisSettings - a consumer that will call methods on KinesisSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    kinesisSettings(KinesisSettings)
  - elasticsearchSettings
```
Endpoint.Builder elasticsearchSettings(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.
  - elasticsearchSettings
```
default Endpoint.Builder elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings)
```
    The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
    This is a convenience that creates an instance of the ElasticsearchSettings.Builder avoiding the need to create one manually via ElasticsearchSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticsearchSettings(ElasticsearchSettings).
    
    Parameters:
    
    elasticsearchSettings - a consumer that will call methods on ElasticsearchSettings.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    elasticsearchSettings(ElasticsearchSettings)

Interface Endpoint.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

endpointIdentifier

endpointType

endpointType

engineName

engineDisplayName

username

serverName

port

databaseName

extraConnectionAttributes

status

kmsKeyId

endpointArn

certificateArn

sslMode

sslMode

serviceAccessRoleArn

externalTableDefinition

externalId

dynamoDbSettings

dynamoDbSettings

s3Settings

s3Settings

dmsTransferSettings

dmsTransferSettings

mongoDbSettings

mongoDbSettings

kinesisSettings

kinesisSettings

elasticsearchSettings

elasticsearchSettings