Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::DataSync::Types::CreateLocationSmbRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

CreateLocationSmbRequest

See Also:

Constant Summary collapse

SENSITIVE = 
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arns ⇒ Array<String>

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).

Returns:

  • (Array<String>) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#authentication_type ⇒ String

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

For more information, see Providing DataSync access to SMB file servers.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#dns_ip_addresses ⇒ Array<String>

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

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

Returns:

  • (Array<String>) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#domain ⇒ String

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

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kerberos_keytab ⇒ String

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

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kerberos_krb_5_conf ⇒ String

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

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kerberos_principal ⇒ String

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

A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG.

Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#mount_options ⇒ Types::SmbMountOptions

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

Returns:


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#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.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_hostname ⇒ String

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

Remember the following when configuring this parameter:

  • You can't specify an IP version 6 (IPv6) address.

  • If you're using Kerberos authentication, you must specify a domain name.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#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.

To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tags ⇒ Array<Types::TagListEntry>

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

Returns:


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#user ⇒ String

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType is set to NTLM.

For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

Returns:

  • (String) 

1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1324

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end