datasync/aws.sdk.kotlin.services.datasync.model/CreateLocationSmbRequest/Builder

Builder

Properties

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

authenticationType

var authenticationType: SmbAuthenticationType?

Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

cmkSecretConfig

var cmkSecretConfig: CmkSecretConfig?

Specifies configuration information for a DataSync-managed secret, either a Password or KerberosKeytab (for NTLM (default) and KERBEROS authentication types, respectively) that DataSync uses to access a specific SMB storage location, with a customer-managed KMS key.

customSecretConfig

var customSecretConfig: CustomSecretConfig?

Specifies configuration information for a customer-managed Secrets Manager secret where the SMB storage location credentials is stored in Secrets Manager as plain text (for Password) or binary (for KerberosKeytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

dnsIpAddresses

var dnsIpAddresses: List<String>?

Specifies the IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

domain

var domain: String?

Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

kerberosKeytab

var kerberosKeytab: ByteArray?

Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

kerberosKrb5Conf

var kerberosKrb5Conf: ByteArray?

Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

kerberosPrincipal

var kerberosPrincipal: String?

Specifies a Kerberos principal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

mountOptions

var mountOptions: SmbMountOptions?

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

password

var password: String?

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

serverHostname

var serverHostname: String?

Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

subdirectory

var subdirectory: String?

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

Functions

cmkSecretConfig

fun cmkSecretConfig(block: CmkSecretConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.datasync.model.CmkSecretConfig inside the given block

customSecretConfig

fun customSecretConfig(block: CustomSecretConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.datasync.model.CustomSecretConfig inside the given block

mountOptions

fun mountOptions(block: SmbMountOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.datasync.model.SmbMountOptions inside the given block