« blib/lib/Paws/Datasync/CreateLocationEfsResponse.pm
↑ Summary
blib/lib/Paws/Datasync/CreateLocationFsxWindowsResponse.pm »
| 1 | |||
| 2 | package Paws::Datasync::CreateLocationFsxWindows; | ||
| 3 | use Moose; | ||
| 4 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 5 | has FsxFilesystemArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Password => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has SecurityGroupArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | has Subdirectory => (is => 'ro', isa => 'Str'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Datasync::TagListEntry]'); | ||
| 10 | has User => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateLocationFsxWindows'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Datasync::CreateLocationFsxWindowsResponse'); | ||
| 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::CreateLocationFsxWindows - Arguments for method CreateLocationFsxWindows on L<Paws::Datasync> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateLocationFsxWindows on the | ||
| 28 | L<AWS DataSync|Paws::Datasync> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateLocationFsxWindows. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateLocationFsxWindows. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $datasync = Paws->service('Datasync'); | ||
| 36 | my $CreateLocationFsxWindowsResponse = $datasync->CreateLocationFsxWindows( | ||
| 37 | FsxFilesystemArn => 'MyFsxFilesystemArn', | ||
| 38 | Password => 'MySmbPassword', | ||
| 39 | SecurityGroupArns => [ | ||
| 40 | 'MyEc2SecurityGroupArn', ... # max: 128 | ||
| 41 | ], | ||
| 42 | User => 'MySmbUser', | ||
| 43 | Domain => 'MySmbDomain', # OPTIONAL | ||
| 44 | Subdirectory => 'MyFsxWindowsSubdirectory', # OPTIONAL | ||
| 45 | Tags => [ | ||
| 46 | { | ||
| 47 | Key => 'MyTagKey', # min: 1, max: 256 | ||
| 48 | Value => 'MyTagValue', # min: 1, max: 256; OPTIONAL | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $LocationArn = $CreateLocationFsxWindowsResponse->LocationArn; | ||
| 56 | |||
| 57 | # Returns a L<Paws::Datasync::CreateLocationFsxWindowsResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datasync/CreateLocationFsxWindows> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Domain => Str | ||
| 66 | |||
| 67 | The name of the Windows domain that the FSx for Windows File Server | ||
| 68 | belongs to. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> FsxFilesystemArn => Str | ||
| 73 | |||
| 74 | The Amazon Resource Name (ARN) for the FSx for Windows File Server file | ||
| 75 | system. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> Password => Str | ||
| 80 | |||
| 81 | The password of the user who has the permissions to access files and | ||
| 82 | folders in the FSx for Windows File Server file system. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> SecurityGroupArns => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | The Amazon Resource Names (ARNs) of the security groups that are to use | ||
| 89 | to configure the FSx for Windows File Server file system. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Subdirectory => Str | ||
| 94 | |||
| 95 | A subdirectory in the locationE<rsquo>s path. This subdirectory in the | ||
| 96 | Amazon FSx for Windows File Server file system is used to read data | ||
| 97 | from the Amazon FSx for Windows File Server source location or write | ||
| 98 | data to the FSx for Windows File Server destination. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Tags => ArrayRef[L<Paws::Datasync::TagListEntry>] | ||
| 103 | |||
| 104 | The key-value pair that represents a tag that you want to add to the | ||
| 105 | resource. The value can be an empty string. This value helps you | ||
| 106 | manage, filter, and search for your resources. We recommend that you | ||
| 107 | create a name tag for your location. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> User => Str | ||
| 112 | |||
| 113 | The user who has the permissions to access files and folders in the FSx | ||
| 114 | for Windows File Server file system. | ||
| 115 | |||
| 116 | For information about choosing a user name that ensures sufficient | ||
| 117 | permissions to files, folders, and metadata, see user. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, documenting arguments for method CreateLocationFsxWindows in L<Paws::Datasync> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |