« blib/lib/Paws/Datasync/UpdateLocationObjectStorageResponse.pm
↑ Summary
blib/lib/Paws/Datasync/UpdateLocationSmbResponse.pm »
| 1 | |||
| 2 | package Paws::Datasync::UpdateLocationSmb; | ||
| 3 | use Moose; | ||
| 4 | has AgentArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 6 | has LocationArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has MountOptions => (is => 'ro', isa => 'Paws::Datasync::SmbMountOptions'); | ||
| 8 | has Password => (is => 'ro', isa => 'Str'); | ||
| 9 | has Subdirectory => (is => 'ro', isa => 'Str'); | ||
| 10 | has User => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateLocationSmb'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Datasync::UpdateLocationSmbResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Datasync::UpdateLocationSmb - Arguments for method UpdateLocationSmb on L<Paws::Datasync> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method UpdateLocationSmb on the | ||
| 28 | L<AWS DataSync|Paws::Datasync> service. Use the attributes of this class | ||
| 29 | as arguments to method UpdateLocationSmb. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateLocationSmb. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $datasync = Paws->service('Datasync'); | ||
| 36 | my $UpdateLocationSmbResponse = $datasync->UpdateLocationSmb( | ||
| 37 | LocationArn => 'MyLocationArn', | ||
| 38 | AgentArns => [ | ||
| 39 | 'MyAgentArn', ... # max: 128 | ||
| 40 | ], # OPTIONAL | ||
| 41 | Domain => 'MySmbDomain', # OPTIONAL | ||
| 42 | MountOptions => { | ||
| 43 | Version => 'AUTOMATIC', # values: AUTOMATIC, SMB2, SMB3; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | Password => 'MySmbPassword', # OPTIONAL | ||
| 46 | Subdirectory => 'MySmbSubdirectory', # OPTIONAL | ||
| 47 | User => 'MySmbUser', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datasync/UpdateLocationSmb> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AgentArns => ArrayRef[Str|Undef] | ||
| 57 | |||
| 58 | The Amazon Resource Names (ARNs) of agents to use for a Simple Message | ||
| 59 | Block (SMB) location. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 Domain => Str | ||
| 64 | |||
| 65 | The name of the Windows domain that the SMB server belongs to. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> LocationArn => Str | ||
| 70 | |||
| 71 | The Amazon Resource Name (ARN) of the SMB location to update. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 MountOptions => L<Paws::Datasync::SmbMountOptions> | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 Password => Str | ||
| 82 | |||
| 83 | The password of the user who can mount the share has the permissions to | ||
| 84 | access files and folders in the SMB share. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Subdirectory => Str | ||
| 89 | |||
| 90 | The subdirectory in the SMB file system that is used to read data from | ||
| 91 | the SMB source location or write data to the SMB destination. The SMB | ||
| 92 | path should be a path that's exported by the SMB server, or a | ||
| 93 | subdirectory of that path. The path should be such that it can be | ||
| 94 | mounted by other SMB clients in your network. | ||
| 95 | |||
| 96 | C<Subdirectory> must be specified with forward slashes. For example, | ||
| 97 | C</path/to/folder>. | ||
| 98 | |||
| 99 | To transfer all the data in the folder that you specified, DataSync | ||
| 100 | must have permissions to mount the SMB share and to access all the data | ||
| 101 | in that share. To ensure this, do either of the following: | ||
| 102 | |||
| 103 | =over | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | Ensure that the user/password specified belongs to the user who can | ||
| 108 | mount the share and who has the appropriate permissions for all of the | ||
| 109 | files and directories that you want DataSync to access. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Use credentials of a member of the Backup Operators group to mount the | ||
| 114 | share. | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | Doing either of these options enables the agent to access the data. For | ||
| 119 | the agent to access directories, you must also enable all execute | ||
| 120 | access. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 User => Str | ||
| 125 | |||
| 126 | The user who can mount the share has the permissions to access files | ||
| 127 | and folders in the SMB share. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, documenting arguments for method UpdateLocationSmb in L<Paws::Datasync> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |