@Generated(value="software.amazon.awssdk:codegen") public final class Endpoint extends Object implements StructuredPojo, ToCopyableBuilder<Endpoint.Builder,Endpoint>
Modifier and Type | Class and Description |
---|---|
static interface |
Endpoint.Builder |
Modifier and Type | Method and Description |
---|---|
static Endpoint.Builder |
builder() |
String |
certificateArn()
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
|
String |
databaseName()
The name of the database at the endpoint.
|
DynamoDbSettings |
dynamoDbSettings()
The settings for the target DynamoDB database.
|
String |
endpointArn()
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
|
String |
endpointIdentifier()
The database endpoint identifier.
|
ReplicationEndpointTypeValue |
endpointType()
The type of endpoint.
|
String |
endpointTypeAsString()
The type of endpoint.
|
String |
engineName()
The database engine name.
|
boolean |
equals(Object obj) |
String |
externalId()
Value returned by a call to CreateEndpoint that can be used for cross-account validation.
|
String |
extraConnectionAttributes()
Additional connection attributes used to connect to the endpoint.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
kmsKeyId()
The KMS key identifier that will be used to encrypt the connection parameters.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
MongoDbSettings |
mongoDbSettings()
The settings for the MongoDB source endpoint.
|
Integer |
port()
The port value used to access the endpoint.
|
S3Settings |
s3Settings()
The settings for the S3 target endpoint.
|
static Class<? extends Endpoint.Builder> |
serializableBuilderClass() |
String |
serverName()
The name of the server at the endpoint.
|
DmsSslModeValue |
sslMode()
The SSL mode used to connect to the endpoint.
|
String |
sslModeAsString()
The SSL mode used to connect to the endpoint.
|
String |
status()
The status of the endpoint.
|
Endpoint.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 used to connect to the endpoint.
|
copy
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.
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()
.
ReplicationEndpointTypeValue
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()
.
ReplicationEndpointTypeValue
public String engineName()
The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.
public String username()
The user name used to connect to the endpoint.
public String serverName()
The name of the server at the endpoint.
public Integer port()
The port value used to access the endpoint.
public String databaseName()
The name of the database at the endpoint.
public String extraConnectionAttributes()
Additional connection attributes used to connect to the endpoint.
public String status()
The status of the endpoint.
public String kmsKeyId()
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
public String endpointArn()
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
public String certificateArn()
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
public 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.
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()
.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
DmsSslModeValue
public String sslModeAsString()
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.
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()
.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
DmsSslModeValue
public 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.
public DynamoDbSettings dynamoDbSettings()
The settings for the target DynamoDB database. For more information, see the DynamoDBSettings
structure.
DynamoDBSettings
structure.public S3Settings s3Settings()
The settings for the S3 target endpoint. For more information, see the S3Settings
structure.
S3Settings
structure.public MongoDbSettings mongoDbSettings()
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.
MongoDbSettings
structure.public Endpoint.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Endpoint.Builder,Endpoint>
public static Endpoint.Builder builder()
public static Class<? extends Endpoint.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.