/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Datasync::UpdateLocationSmb

NAME

Paws::Datasync::UpdateLocationSmb - Arguments for method UpdateLocationSmb on Paws::Datasync

DESCRIPTION

This class represents the parameters used for calling the method UpdateLocationSmb on the AWS DataSync service. Use the attributes of this class as arguments to method UpdateLocationSmb.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateLocationSmb.

SYNOPSIS

my $datasync = Paws->service('Datasync');
my $UpdateLocationSmbResponse = $datasync->UpdateLocationSmb(
  LocationArn => 'MyLocationArn',
  AgentArns   => [
    'MyAgentArn', ...    # max: 128
  ],    # OPTIONAL
  Domain       => 'MySmbDomain',    # OPTIONAL
  MountOptions => {
    Version => 'AUTOMATIC',    # values: AUTOMATIC, SMB2, SMB3; OPTIONAL
  },    # OPTIONAL
  Password     => 'MySmbPassword',        # OPTIONAL
  Subdirectory => 'MySmbSubdirectory',    # OPTIONAL
  User         => 'MySmbUser',            # OPTIONAL
);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/datasync/UpdateLocationSmb

ATTRIBUTES

AgentArns => ArrayRef[Str|Undef]

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

Domain => Str

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

REQUIRED LocationArn => Str

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

MountOptions => Paws::Datasync::SmbMountOptions

Password => Str

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

Subdirectory => Str

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.

User => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateLocationSmb in Paws::Datasync

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues