Package software.amazon.awssdk.services.databasemigration.model

Class SybaseSettings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.SybaseSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SybaseSettings.Builder,SybaseSettings>

@Generated("software.amazon.awssdk:codegen")
public final class SybaseSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SybaseSettings.Builder,SybaseSettings>

Provides information that defines a SAP ASE endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SybaseSettings.Builder

Method Summary

Modifier and Type	Method	Description
static SybaseSettings.Builder	builder()
String	databaseName()	Database name for the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	password()	Endpoint connection password.
Integer	port()	Endpoint TCP port.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secretsManagerAccessRoleArn()	The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
String	secretsManagerSecretId()	The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
static Class<? extends SybaseSettings.Builder>	serializableBuilderClass()
String	serverName()	Fully qualified domain name of the endpoint.
SybaseSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	Endpoint connection user name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

databaseName

public final String databaseName()

Database name for the endpoint.

Returns:

Database name for the endpoint.

password

public final String password()

Endpoint connection password.

Returns:

Endpoint connection password.

port

public final Integer port()

Endpoint TCP port. The default is 5000.

Returns:

Endpoint TCP port. The default is 5000.

serverName

public final String serverName()

Fully qualified domain name of the endpoint.

Returns:

Fully qualified domain name of the endpoint.

username

public final String username()

Endpoint connection user name.

Returns:

Endpoint connection user name.

secretsManagerAccessRoleArn

public final String secretsManagerAccessRoleArn()

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Returns:

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

secretsManagerSecretId

public final String secretsManagerSecretId()

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

Returns:

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

toBuilder

public SybaseSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SybaseSettings.Builder,SybaseSettings>

builder

public static SybaseSettings.Builder builder()

serializableBuilderClass

public static Class<? extends SybaseSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo