CreateEndpointRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
    - - software.amazon.awssdk.services.databasemigration.model.CreateEndpointRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEndpointRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEndpointRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEndpointRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateEndpointRequest.Builder`	`builder()`
`String`	`certificateArn()` The Amazon Resource Name (ARN) for the certificate.
`String`	`databaseName()` The name of the endpoint database.
`DmsTransferSettings`	`dmsTransferSettings()` The settings in JSON format for the DMS transfer type of source endpoint.
`DynamoDbSettings`	`dynamoDbSettings()` Settings in JSON format for the target Amazon DynamoDB endpoint.
`ElasticsearchSettings`	`elasticsearchSettings()` Settings in JSON format for the target Elasticsearch endpoint.
`String`	`endpointIdentifier()` The database endpoint identifier.
`ReplicationEndpointTypeValue`	`endpointType()` The type of endpoint.
`String`	`endpointTypeAsString()` The type of endpoint.
`String`	`engineName()` The type of engine for the endpoint.
`boolean`	`equals(Object obj)`
`String`	`externalTableDefinition()` The external table definition.
`String`	`extraConnectionAttributes()` Additional attributes associated with the connection.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`KinesisSettings`	`kinesisSettings()` Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
`String`	`kmsKeyId()` The AWS KMS key identifier to use to encrypt the connection parameters.
`MongoDbSettings`	`mongoDbSettings()` Settings in JSON format for the source MongoDB endpoint.
`String`	`password()` The password to be used to log in to the endpoint database.
`Integer`	`port()` The port used by the endpoint database.
`S3Settings`	`s3Settings()` Settings in JSON format for the target Amazon S3 endpoint.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateEndpointRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverName()` The name of the server where the endpoint database resides.
`String`	`serviceAccessRoleArn()` The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
`DmsSslModeValue`	`sslMode()` The Secure Sockets Layer (SSL) mode to use for the SSL connection.
`String`	`sslModeAsString()` The Secure Sockets Layer (SSL) mode to use for the SSL connection.
`List<Tag>`	`tags()` Tags to be added to the endpoint.
`CreateEndpointRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`username()` The user name to be used to log in to the endpoint database.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - endpointIdentifier
```
public 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.
    
    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.
  - endpointType
```
public ReplicationEndpointTypeValue endpointType()
```
    The type of endpoint.
    
    If the service returns an enum value that is not available in the current SDK version, endpointType will return ReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().
    
    Returns:
    
    The type of endpoint.
    
    See Also:
    
    ReplicationEndpointTypeValue
  - endpointTypeAsString
```
public String endpointTypeAsString()
```
    The type of endpoint.
    
    If the service returns an enum value that is not available in the current SDK version, endpointType will return ReplicationEndpointTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().
    
    Returns:
    
    The type of endpoint.
    
    See Also:
    
    ReplicationEndpointTypeValue
  - engineName
```
public String engineName()
```
    The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
    
    Returns:
    
    The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
  - username
```
public String username()
```
    The user name to be used to log in to the endpoint database.
    
    Returns:
    
    The user name to be used to log in to the endpoint database.
  - password
```
public String password()
```
    The password to be used to log in to the endpoint database.
    
    Returns:
    
    The password to be used to log in to the endpoint database.
  - serverName
```
public String serverName()
```
    The name of the server where the endpoint database resides.
    
    Returns:
    
    The name of the server where the endpoint database resides.
  - port
```
public Integer port()
```
    The port used by the endpoint database.
    
    Returns:
    
    The port used by the endpoint database.
  - databaseName
```
public String databaseName()
```
    The name of the endpoint database.
    
    Returns:
    
    The name of the endpoint database.
  - extraConnectionAttributes
```
public String extraConnectionAttributes()
```
    Additional attributes associated with the connection.
    
    Returns:
    
    Additional attributes associated with the connection.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key identifier to use to encrypt the connection parameters. 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 to use to encrypt the connection parameters. 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.
  - tags
```
public List<Tag> tags()
```
    Tags to be added to the endpoint.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Tags to be added to the endpoint.
  - certificateArn
```
public String certificateArn()
```
    The Amazon Resource Name (ARN) for the certificate.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the certificate.
  - sslMode
```
public DmsSslModeValue sslMode()
```
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
    
    If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().
    
    Returns:
    
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
    
    See Also:
    
    DmsSslModeValue
  - sslModeAsString
```
public String sslModeAsString()
```
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
    
    If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().
    
    Returns:
    
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
    
    See Also:
    
    DmsSslModeValue
  - serviceAccessRoleArn
```
public String serviceAccessRoleArn()
```
    The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
  - externalTableDefinition
```
public String externalTableDefinition()
```
    The external table definition.
    
    Returns:
    
    The external table definition.
  - dynamoDbSettings
```
public DynamoDbSettings dynamoDbSettings()
```
    Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
  - s3Settings
```
public S3Settings s3Settings()
```
    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
  - dmsTransferSettings
```
public 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" }
    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" }
  - mongoDbSettings
```
public MongoDbSettings mongoDbSettings()
```
    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
    
    Returns:
    
    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
  - kinesisSettings
```
public KinesisSettings kinesisSettings()
```
    Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
    
    Returns:
    
    Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
  - elasticsearchSettings
```
public ElasticsearchSettings elasticsearchSettings()
```
    Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.
    
    Returns:
    
    Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.
  - toBuilder
```
public CreateEndpointRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>
    
    Specified by:
    
    toBuilder in class DatabaseMigrationRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateEndpointRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateEndpointRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateEndpointRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

endpointIdentifier

endpointType

endpointTypeAsString

engineName

username

password

serverName

port

databaseName

extraConnectionAttributes

kmsKeyId

tags

certificateArn

sslMode

sslModeAsString

serviceAccessRoleArn

externalTableDefinition

dynamoDbSettings

s3Settings

dmsTransferSettings

mongoDbSettings

kinesisSettings

elasticsearchSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields