« blib/lib/Paws/FSX/CreateFileSystemFromBackupResponse.pm
↑ Summary
blib/lib/Paws/FSX/CreateFileSystemResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::CreateFileSystemLustreConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AutoImportPolicy => (is => 'ro', isa => 'Str'); | ||
| 5 | has AutomaticBackupRetentionDays => (is => 'ro', isa => 'Int'); | ||
| 6 | has CopyTagsToBackups => (is => 'ro', isa => 'Bool'); | ||
| 7 | has DailyAutomaticBackupStartTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has DataCompressionType => (is => 'ro', isa => 'Str'); | ||
| 9 | has DeploymentType => (is => 'ro', isa => 'Str'); | ||
| 10 | has DriveCacheType => (is => 'ro', isa => 'Str'); | ||
| 11 | has ExportPath => (is => 'ro', isa => 'Str'); | ||
| 12 | has ImportedFileChunkSize => (is => 'ro', isa => 'Int'); | ||
| 13 | has ImportPath => (is => 'ro', isa => 'Str'); | ||
| 14 | has PerUnitStorageThroughput => (is => 'ro', isa => 'Int'); | ||
| 15 | has WeeklyMaintenanceStartTime => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::FSX::CreateFileSystemLustreConfiguration | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::FSX::CreateFileSystemLustreConfiguration object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { AutoImportPolicy => $value, ..., WeeklyMaintenanceStartTime => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::CreateFileSystemLustreConfiguration object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->AutoImportPolicy | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | The Lustre configuration for the file system being created. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 AutoImportPolicy => Str | ||
| 53 | |||
| 54 | (Optional) When you create your file system, your existing S3 objects | ||
| 55 | appear as file and directory listings. Use this property to choose how | ||
| 56 | Amazon FSx keeps your file and directory listings up to date as you add | ||
| 57 | or modify objects in your linked S3 bucket. C<AutoImportPolicy> can | ||
| 58 | have the following values: | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | C<NONE> - (Default) AutoImport is off. Amazon FSx only updates file and | ||
| 65 | directory listings from the linked S3 bucket when the file system is | ||
| 66 | created. FSx does not update file and directory listings for any new or | ||
| 67 | changed objects after choosing this option. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<NEW> - AutoImport is on. Amazon FSx automatically imports directory | ||
| 72 | listings of any new objects added to the linked S3 bucket that do not | ||
| 73 | currently exist in the FSx file system. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<NEW_CHANGED> - AutoImport is on. Amazon FSx automatically imports | ||
| 78 | file and directory listings of any new objects added to the S3 bucket | ||
| 79 | and any existing objects that are changed in the S3 bucket after you | ||
| 80 | choose this option. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | For more information, see Automatically import updates from your S3 | ||
| 85 | bucket | ||
| 86 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html). | ||
| 87 | |||
| 88 | |||
| 89 | =head2 AutomaticBackupRetentionDays => Int | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 CopyTagsToBackups => Bool | ||
| 95 | |||
| 96 | (Optional) Not available to use with file systems that are linked to a | ||
| 97 | data repository. A boolean flag indicating whether tags for the file | ||
| 98 | system should be copied to backups. The default value is false. If it's | ||
| 99 | set to true, all file system tags are copied to all automatic and | ||
| 100 | user-initiated backups when the user doesn't specify any | ||
| 101 | backup-specific tags. If this value is true, and you specify one or | ||
| 102 | more backup tags, only the specified tags are copied to backups. If you | ||
| 103 | specify one or more tags when creating a user-initiated backup, no tags | ||
| 104 | are copied from the file system, regardless of this value. | ||
| 105 | |||
| 106 | For more information, see Working with backups | ||
| 107 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html). | ||
| 108 | |||
| 109 | |||
| 110 | =head2 DailyAutomaticBackupStartTime => Str | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 DataCompressionType => Str | ||
| 116 | |||
| 117 | Sets the data compression configuration for the file system. | ||
| 118 | C<DataCompressionType> can have the following values: | ||
| 119 | |||
| 120 | =over | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | C<NONE> - (Default) Data compression is turned off when the file system | ||
| 125 | is created. | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | C<LZ4> - Data compression is turned on with the LZ4 algorithm. | ||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | For more information, see Lustre data compression | ||
| 134 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html). | ||
| 135 | |||
| 136 | |||
| 137 | =head2 DeploymentType => Str | ||
| 138 | |||
| 139 | Choose C<SCRATCH_1> and C<SCRATCH_2> deployment types when you need | ||
| 140 | temporary storage and shorter-term processing of data. The C<SCRATCH_2> | ||
| 141 | deployment type provides in-transit encryption of data and higher burst | ||
| 142 | throughput capacity than C<SCRATCH_1>. | ||
| 143 | |||
| 144 | Choose C<PERSISTENT_1> deployment type for longer-term storage and | ||
| 145 | workloads and encryption of data in transit. To learn more about | ||
| 146 | deployment types, see FSx for Lustre Deployment Options | ||
| 147 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html). | ||
| 148 | |||
| 149 | Encryption of data in-transit is automatically enabled when you access | ||
| 150 | a C<SCRATCH_2> or C<PERSISTENT_1> file system from Amazon EC2 instances | ||
| 151 | that support this feature | ||
| 152 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- | ||
| 153 | protection.html). (Default = C<SCRATCH_1>) | ||
| 154 | |||
| 155 | Encryption of data in-transit for C<SCRATCH_2> and C<PERSISTENT_1> | ||
| 156 | deployment types is supported when accessed from supported instance | ||
| 157 | types in supported AWS Regions. To learn more, Encrypting Data in | ||
| 158 | Transit | ||
| 159 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html). | ||
| 160 | |||
| 161 | |||
| 162 | =head2 DriveCacheType => Str | ||
| 163 | |||
| 164 | The type of drive cache used by PERSISTENT_1 file systems that are | ||
| 165 | provisioned with HDD storage devices. This parameter is required when | ||
| 166 | storage type is HDD. Set to C<READ>, improve the performance for | ||
| 167 | frequently accessed files and allows 20% of the total storage capacity | ||
| 168 | of the file system to be cached. | ||
| 169 | |||
| 170 | This parameter is required when C<StorageType> is set to HDD. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 ExportPath => Str | ||
| 174 | |||
| 175 | (Optional) The path in Amazon S3 where the root of your Amazon FSx file | ||
| 176 | system is exported. The path must use the same Amazon S3 bucket as | ||
| 177 | specified in ImportPath. You can provide an optional prefix to which | ||
| 178 | new and changed data is to be exported from your Amazon FSx for Lustre | ||
| 179 | file system. If an C<ExportPath> value is not provided, Amazon FSx sets | ||
| 180 | a default export path, | ||
| 181 | C<s3://import-bucket/FSxLustre[creation-timestamp]>. The timestamp is | ||
| 182 | in UTC format, for example | ||
| 183 | C<s3://import-bucket/FSxLustre20181105T222312Z>. | ||
| 184 | |||
| 185 | The Amazon S3 export bucket must be the same as the import bucket | ||
| 186 | specified by C<ImportPath>. If you only specify a bucket name, such as | ||
| 187 | C<s3://import-bucket>, you get a 1:1 mapping of file system objects to | ||
| 188 | S3 bucket objects. This mapping means that the input data in S3 is | ||
| 189 | overwritten on export. If you provide a custom prefix in the export | ||
| 190 | path, such as C<s3://import-bucket/[custom-optional-prefix]>, Amazon | ||
| 191 | FSx exports the contents of your file system to that export prefix in | ||
| 192 | the Amazon S3 bucket. | ||
| 193 | |||
| 194 | |||
| 195 | =head2 ImportedFileChunkSize => Int | ||
| 196 | |||
| 197 | (Optional) For files imported from a data repository, this value | ||
| 198 | determines the stripe count and maximum amount of data per file (in | ||
| 199 | MiB) stored on a single physical disk. The maximum number of disks that | ||
| 200 | a single file can be striped across is limited by the total number of | ||
| 201 | disks that make up the file system. | ||
| 202 | |||
| 203 | The default chunk size is 1,024 MiB (1 GiB) and can go as high as | ||
| 204 | 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 ImportPath => Str | ||
| 208 | |||
| 209 | (Optional) The path to the Amazon S3 bucket (including the optional | ||
| 210 | prefix) that you're using as the data repository for your Amazon FSx | ||
| 211 | for Lustre file system. The root of your FSx for Lustre file system | ||
| 212 | will be mapped to the root of the Amazon S3 bucket you select. An | ||
| 213 | example is C<s3://import-bucket/optional-prefix>. If you specify a | ||
| 214 | prefix after the Amazon S3 bucket name, only object keys with that | ||
| 215 | prefix are loaded into the file system. | ||
| 216 | |||
| 217 | |||
| 218 | =head2 PerUnitStorageThroughput => Int | ||
| 219 | |||
| 220 | Required for the C<PERSISTENT_1> deployment type, describes the amount | ||
| 221 | of read and write throughput for each 1 tebibyte of storage, in | ||
| 222 | MB/s/TiB. File system throughput capacity is calculated by multiplying | ||
| 223 | le system storage capacity (TiB) by the PerUnitStorageThroughput | ||
| 224 | (MB/s/TiB). For a 2.4 TiB le system, provisioning 50 MB/s/TiB of | ||
| 225 | PerUnitStorageThroughput yields 120 MB/s of le system throughput. You | ||
| 226 | pay for the amount of throughput that you provision. | ||
| 227 | |||
| 228 | Valid values for SSD storage: 50, 100, 200. Valid values for HDD | ||
| 229 | storage: 12, 40. | ||
| 230 | |||
| 231 | |||
| 232 | =head2 WeeklyMaintenanceStartTime => Str | ||
| 233 | |||
| 234 | (Optional) The preferred start time to perform weekly maintenance, | ||
| 235 | formatted d:HH:MM in the UTC time zone, where d is the weekday number, | ||
| 236 | from 1 through 7, beginning with Monday and ending with Sunday. | ||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | =head1 SEE ALSO | ||
| 241 | |||
| 242 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 243 | |||
| 244 | =head1 BUGS and CONTRIBUTIONS | ||
| 245 | |||
| 246 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 247 | |||
| 248 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 249 | |||
| 250 | =cut | ||
| 251 |