software.amazon.awssdk.services.databasemigration.model

Interface SybaseSettings.Builder

All Superinterfaces:

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

Enclosing class:

SybaseSettings

public static interface SybaseSettings.Builder
extends SdkPojo, CopyableBuilder<SybaseSettings.Builder,SybaseSettings>

Method Summary

Modifier and Type	Method and Description
SybaseSettings.Builder	databaseName(String databaseName) Database name for the endpoint.
SybaseSettings.Builder	password(String password) Endpoint connection password.
SybaseSettings.Builder	port(Integer port) Endpoint TCP port.
SybaseSettings.Builder	secretsManagerAccessRoleArn(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.
SybaseSettings.Builder	secretsManagerSecretId(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
SybaseSettings.Builder	serverName(String serverName) Fully qualified domain name of the endpoint.
SybaseSettings.Builder	username(String username) Endpoint connection user name.

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

equalsBySdkFields, 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

databaseName

SybaseSettings.Builder databaseName(String databaseName)

Database name for the endpoint.

Parameters:

databaseName - Database name for the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

password

SybaseSettings.Builder password(String password)

Endpoint connection password.

Parameters:

password - Endpoint connection password.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

SybaseSettings.Builder port(Integer port)

Endpoint TCP port. The default is 5000.

Parameters:

port - Endpoint TCP port. The default is 5000.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

SybaseSettings.Builder serverName(String serverName)

Fully qualified domain name of the endpoint.

Parameters:

serverName - Fully qualified domain name of the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

username

SybaseSettings.Builder username(String username)

Endpoint connection user name.

Parameters:

username - Endpoint connection user name.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerAccessRoleArn

SybaseSettings.Builder secretsManagerAccessRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

secretsManagerSecretId

SybaseSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.