« blib/lib/Paws/FSX/CreateBackupResponse.pm
↑ Summary
blib/lib/Paws/FSX/CreateDataRepositoryTaskResponse.pm »
| 1 | |||
| 2 | package Paws::FSX::CreateDataRepositoryTask; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has FileSystemId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Paths => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has Report => (is => 'ro', isa => 'Paws::FSX::CompletionReport', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Tag]'); | ||
| 9 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataRepositoryTask'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FSX::CreateDataRepositoryTaskResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::FSX::CreateDataRepositoryTask - Arguments for method CreateDataRepositoryTask on L<Paws::FSX> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateDataRepositoryTask on the | ||
| 27 | L<Amazon FSx|Paws::FSX> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateDataRepositoryTask. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataRepositoryTask. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $fsx = Paws->service('FSX'); | ||
| 35 | my $CreateDataRepositoryTaskResponse = $fsx->CreateDataRepositoryTask( | ||
| 36 | FileSystemId => 'MyFileSystemId', | ||
| 37 | Report => { | ||
| 38 | Enabled => 1, | ||
| 39 | Format => 'REPORT_CSV_20191124', # values: REPORT_CSV_20191124; OPTIONAL | ||
| 40 | Path => 'MyArchivePath', # min: 3, max: 4357; OPTIONAL | ||
| 41 | Scope => 'FAILED_FILES_ONLY', # values: FAILED_FILES_ONLY; OPTIONAL | ||
| 42 | }, | ||
| 43 | Type => 'EXPORT_TO_REPOSITORY', | ||
| 44 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 45 | Paths => [ | ||
| 46 | 'MyDataRepositoryTaskPath', ... # max: 4096 | ||
| 47 | ], # OPTIONAL | ||
| 48 | Tags => [ | ||
| 49 | { | ||
| 50 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 51 | Value => 'MyTagValue', # max: 256 | ||
| 52 | |||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $DataRepositoryTask = | ||
| 60 | $CreateDataRepositoryTaskResponse->DataRepositoryTask; | ||
| 61 | |||
| 62 | # Returns a L<Paws::FSX::CreateDataRepositoryTaskResponse> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fsx/CreateDataRepositoryTask> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 ClientRequestToken => Str | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Paths => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | (Optional) The path or paths on the Amazon FSx file system to use when | ||
| 85 | the data repository task is processed. The default path is the file | ||
| 86 | system root directory. The paths you provide need to be relative to the | ||
| 87 | mount point of the file system. If the mount point is C</mnt/fsx> and | ||
| 88 | C</mnt/fsx/path1> is a directory or file on the file system you want to | ||
| 89 | export, then the path to provide is C<path1>. If a path that you | ||
| 90 | provide isn't valid, the task fails. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> Report => L<Paws::FSX::CompletionReport> | ||
| 95 | |||
| 96 | Defines whether or not Amazon FSx provides a CompletionReport once the | ||
| 97 | task has completed. A CompletionReport provides a detailed report on | ||
| 98 | the files that Amazon FSx processed that meet the criteria specified by | ||
| 99 | the C<Scope> parameter. For more information, see Working with Task | ||
| 100 | Completion Reports | ||
| 101 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html). | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Tags => ArrayRef[L<Paws::FSX::Tag>] | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> Type => Str | ||
| 112 | |||
| 113 | Specifies the type of data repository task to create. | ||
| 114 | |||
| 115 | Valid values are: C<"EXPORT_TO_REPOSITORY"> | ||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method CreateDataRepositoryTask in L<Paws::FSX> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |