Class: Aws::DataSync::Types::UpdateLocationSmbRequest

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

Overview

Note:

When making an API call, you may pass UpdateLocationSmbRequest data as a hash:

{
  location_arn: "LocationArn", # required
  subdirectory: "SmbSubdirectory",
  user: "SmbUser",
  domain: "SmbDomain",
  password: "SmbPassword",
  agent_arns: ["AgentArn"],
  mount_options: {
    version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
  },
}

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arnsArray<String>

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

  • (Array<String>)


3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end

#domainString

The name of the Windows domain that the SMB server belongs to.

Returns:

  • (String)


3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end

#location_arnString

The Amazon Resource Name (ARN) of the SMB location to update.

Returns:

  • (String)


3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end

#mount_optionsTypes::SmbMountOptions

Represents the mount options that are available for DataSync to access an SMB location.



3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

Returns:

  • (String)


3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end

#subdirectoryString

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

  • Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.

  • Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

Returns:

  • (String)


3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end

#userString

The user who can mount the share has the permissions to access files and folders in the SMB share.

Returns:

  • (String)


3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3875

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  SENSITIVE = [:password]
  include Aws::Structure
end