« blib/lib/Paws/FSX/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/FSX/UpdateFileSystemLustreConfiguration.pm »
| 1 | |||
| 2 | package Paws::FSX::UpdateFileSystem; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has FileSystemId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has LustreConfiguration => (is => 'ro', isa => 'Paws::FSX::UpdateFileSystemLustreConfiguration'); | ||
| 7 | has StorageCapacity => (is => 'ro', isa => 'Int'); | ||
| 8 | has WindowsConfiguration => (is => 'ro', isa => 'Paws::FSX::UpdateFileSystemWindowsConfiguration'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateFileSystem'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FSX::UpdateFileSystemResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::FSX::UpdateFileSystem - Arguments for method UpdateFileSystem on L<Paws::FSX> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateFileSystem on the | ||
| 26 | L<Amazon FSx|Paws::FSX> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateFileSystem. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateFileSystem. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $fsx = Paws->service('FSX'); | ||
| 34 | my $UpdateFileSystemResponse = $fsx->UpdateFileSystem( | ||
| 35 | FileSystemId => 'MyFileSystemId', | ||
| 36 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 37 | LustreConfiguration => { | ||
| 38 | AutoImportPolicy => 'NONE', # values: NONE, NEW, NEW_CHANGED; OPTIONAL | ||
| 39 | AutomaticBackupRetentionDays => 1, # max: 90; OPTIONAL | ||
| 40 | DailyAutomaticBackupStartTime => | ||
| 41 | 'MyDailyTime', # min: 5, max: 5; OPTIONAL | ||
| 42 | DataCompressionType => 'NONE', # values: NONE, LZ4; OPTIONAL | ||
| 43 | WeeklyMaintenanceStartTime => 'MyWeeklyTime', # min: 7, max: 7; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | StorageCapacity => 1, # OPTIONAL | ||
| 46 | WindowsConfiguration => { | ||
| 47 | AuditLogConfiguration => { | ||
| 48 | FileAccessAuditLogLevel => 'DISABLED' | ||
| 49 | , # values: DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE | ||
| 50 | FileShareAccessAuditLogLevel => 'DISABLED' | ||
| 51 | , # values: DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE | ||
| 52 | AuditLogDestination => 'MyGeneralARN', # min: 8, max: 1024; OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | AutomaticBackupRetentionDays => 1, # max: 90; OPTIONAL | ||
| 55 | DailyAutomaticBackupStartTime => | ||
| 56 | 'MyDailyTime', # min: 5, max: 5; OPTIONAL | ||
| 57 | SelfManagedActiveDirectoryConfiguration => { | ||
| 58 | DnsIps => [ | ||
| 59 | 'MyIpAddress', ... # min: 7, max: 15 | ||
| 60 | ], # min: 1, max: 2; OPTIONAL | ||
| 61 | Password => 'MyDirectoryPassword', # min: 1, max: 256; OPTIONAL | ||
| 62 | UserName => 'MyDirectoryUserName', # min: 1, max: 256; OPTIONAL | ||
| 63 | }, # OPTIONAL | ||
| 64 | ThroughputCapacity => 1, # min: 8, max: 2048; OPTIONAL | ||
| 65 | WeeklyMaintenanceStartTime => 'MyWeeklyTime', # min: 7, max: 7; OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | # Results: | ||
| 70 | my $FileSystem = $UpdateFileSystemResponse->FileSystem; | ||
| 71 | |||
| 72 | # Returns a L<Paws::FSX::UpdateFileSystemResponse> object. | ||
| 73 | |||
| 74 | 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. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fsx/UpdateFileSystem> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 ClientRequestToken => Str | ||
| 81 | |||
| 82 | A string of up to 64 ASCII characters that Amazon FSx uses to ensure | ||
| 83 | idempotent updates. This string is automatically filled on your behalf | ||
| 84 | when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 89 | |||
| 90 | Identifies the file system that you are updating. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 LustreConfiguration => L<Paws::FSX::UpdateFileSystemLustreConfiguration> | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 StorageCapacity => Int | ||
| 101 | |||
| 102 | Use this parameter to increase the storage capacity of an Amazon FSx | ||
| 103 | file system. Specifies the storage capacity target value, GiB, to | ||
| 104 | increase the storage capacity for the file system that you're updating. | ||
| 105 | You cannot make a storage capacity increase request if there is an | ||
| 106 | existing storage capacity increase request in progress. | ||
| 107 | |||
| 108 | For Windows file systems, the storage capacity target value must be at | ||
| 109 | least 10 percent (%) greater than the current storage capacity value. | ||
| 110 | In order to increase storage capacity, the file system must have at | ||
| 111 | least 16 MB/s of throughput capacity. | ||
| 112 | |||
| 113 | For Lustre file systems, the storage capacity target value can be the | ||
| 114 | following: | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | For C<SCRATCH_2> and C<PERSISTENT_1 SSD> deployment types, valid values | ||
| 121 | are in multiples of 2400 GiB. The value must be greater than the | ||
| 122 | current storage capacity. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | For C<PERSISTENT HDD> file systems, valid values are multiples of 6000 | ||
| 127 | GiB for 12 MB/s/TiB file systems and multiples of 1800 GiB for 40 | ||
| 128 | MB/s/TiB file systems. The values must be greater than the current | ||
| 129 | storage capacity. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | For C<SCRATCH_1> file systems, you cannot increase the storage | ||
| 134 | capacity. | ||
| 135 | |||
| 136 | =back | ||
| 137 | |||
| 138 | For more information, see Managing storage capacity | ||
| 139 | (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) | ||
| 140 | in the I<Amazon FSx for Windows File Server User Guide> and Managing | ||
| 141 | storage and throughput capacity | ||
| 142 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) | ||
| 143 | in the I<Amazon FSx for Lustre User Guide>. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 WindowsConfiguration => L<Paws::FSX::UpdateFileSystemWindowsConfiguration> | ||
| 148 | |||
| 149 | The configuration updates for an Amazon FSx for Windows File Server | ||
| 150 | file system. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head1 SEE ALSO | ||
| 156 | |||
| 157 | This class forms part of L<Paws>, documenting arguments for method UpdateFileSystem in L<Paws::FSX> | ||
| 158 | |||
| 159 | =head1 BUGS and CONTRIBUTIONS | ||
| 160 | |||
| 161 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 162 | |||
| 163 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 164 | |||
| 165 | =cut | ||
| 166 |