« blib/lib/Paws/FSX/CreateFileSystem.pm
↑ Summary
blib/lib/Paws/FSX/CreateFileSystemFromBackupResponse.pm »
| 1 | |||
| 2 | package Paws::FSX::CreateFileSystemFromBackup; | ||
| 3 | use Moose; | ||
| 4 | has BackupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has LustreConfiguration => (is => 'ro', isa => 'Paws::FSX::CreateFileSystemLustreConfiguration'); | ||
| 8 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 10 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Tag]'); | ||
| 12 | has WindowsConfiguration => (is => 'ro', isa => 'Paws::FSX::CreateFileSystemWindowsConfiguration'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFileSystemFromBackup'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FSX::CreateFileSystemFromBackupResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::FSX::CreateFileSystemFromBackup - Arguments for method CreateFileSystemFromBackup on L<Paws::FSX> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateFileSystemFromBackup on the | ||
| 30 | L<Amazon FSx|Paws::FSX> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateFileSystemFromBackup. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFileSystemFromBackup. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $fsx = Paws->service('FSX'); | ||
| 38 | my $CreateFileSystemFromBackupResponse = $fsx->CreateFileSystemFromBackup( | ||
| 39 | BackupId => 'MyBackupId', | ||
| 40 | SubnetIds => [ | ||
| 41 | 'MySubnetId', ... # min: 15, max: 24 | ||
| 42 | ], | ||
| 43 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 44 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 45 | LustreConfiguration => { | ||
| 46 | AutoImportPolicy => 'NONE', # values: NONE, NEW, NEW_CHANGED; OPTIONAL | ||
| 47 | AutomaticBackupRetentionDays => 1, # max: 90; OPTIONAL | ||
| 48 | CopyTagsToBackups => 1, # OPTIONAL | ||
| 49 | DailyAutomaticBackupStartTime => | ||
| 50 | 'MyDailyTime', # min: 5, max: 5; OPTIONAL | ||
| 51 | DataCompressionType => 'NONE', # values: NONE, LZ4; OPTIONAL | ||
| 52 | DeploymentType => | ||
| 53 | 'SCRATCH_1', # values: SCRATCH_1, SCRATCH_2, PERSISTENT_1; OPTIONAL | ||
| 54 | DriveCacheType => 'NONE', # values: NONE, READ; OPTIONAL | ||
| 55 | ExportPath => 'MyArchivePath', # min: 3, max: 4357; OPTIONAL | ||
| 56 | ImportPath => 'MyArchivePath', # min: 3, max: 4357; OPTIONAL | ||
| 57 | ImportedFileChunkSize => 1, # min: 1, max: 512000; OPTIONAL | ||
| 58 | PerUnitStorageThroughput => 1, # min: 12, max: 200; OPTIONAL | ||
| 59 | WeeklyMaintenanceStartTime => 'MyWeeklyTime', # min: 7, max: 7; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | SecurityGroupIds => [ | ||
| 62 | 'MySecurityGroupId', ... # min: 11, max: 20 | ||
| 63 | ], # OPTIONAL | ||
| 64 | StorageType => 'SSD', # OPTIONAL | ||
| 65 | Tags => [ | ||
| 66 | { | ||
| 67 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 68 | Value => 'MyTagValue', # max: 256 | ||
| 69 | |||
| 70 | }, | ||
| 71 | ... | ||
| 72 | ], # OPTIONAL | ||
| 73 | WindowsConfiguration => { | ||
| 74 | ThroughputCapacity => 1, # min: 8, max: 2048 | ||
| 75 | ActiveDirectoryId => 'MyDirectoryId', # min: 12, max: 12; OPTIONAL | ||
| 76 | Aliases => [ | ||
| 77 | 'MyAlternateDNSName', ... # min: 4, max: 253 | ||
| 78 | ], # max: 50; OPTIONAL | ||
| 79 | AuditLogConfiguration => { | ||
| 80 | FileAccessAuditLogLevel => 'DISABLED' | ||
| 81 | , # values: DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE | ||
| 82 | FileShareAccessAuditLogLevel => 'DISABLED' | ||
| 83 | , # values: DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE | ||
| 84 | AuditLogDestination => 'MyGeneralARN', # min: 8, max: 1024; OPTIONAL | ||
| 85 | }, # OPTIONAL | ||
| 86 | AutomaticBackupRetentionDays => 1, # max: 90; OPTIONAL | ||
| 87 | CopyTagsToBackups => 1, # OPTIONAL | ||
| 88 | DailyAutomaticBackupStartTime => | ||
| 89 | 'MyDailyTime', # min: 5, max: 5; OPTIONAL | ||
| 90 | DeploymentType => | ||
| 91 | 'MULTI_AZ_1', # values: MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2; OPTIONAL | ||
| 92 | PreferredSubnetId => 'MySubnetId', # min: 15, max: 24 | ||
| 93 | SelfManagedActiveDirectoryConfiguration => { | ||
| 94 | DnsIps => [ | ||
| 95 | 'MyIpAddress', ... # min: 7, max: 15 | ||
| 96 | ], # min: 1, max: 2 | ||
| 97 | DomainName => | ||
| 98 | 'MyActiveDirectoryFullyQualifiedName', # min: 1, max: 255 | ||
| 99 | Password => 'MyDirectoryPassword', # min: 1, max: 256 | ||
| 100 | UserName => 'MyDirectoryUserName', # min: 1, max: 256 | ||
| 101 | FileSystemAdministratorsGroup => | ||
| 102 | 'MyFileSystemAdministratorsGroupName', # min: 1, max: 256; OPTIONAL | ||
| 103 | OrganizationalUnitDistinguishedName => | ||
| 104 | 'MyOrganizationalUnitDistinguishedName' | ||
| 105 | , # min: 1, max: 2000; OPTIONAL | ||
| 106 | }, # OPTIONAL | ||
| 107 | WeeklyMaintenanceStartTime => 'MyWeeklyTime', # min: 7, max: 7; OPTIONAL | ||
| 108 | }, # OPTIONAL | ||
| 109 | ); | ||
| 110 | |||
| 111 | # Results: | ||
| 112 | my $FileSystem = $CreateFileSystemFromBackupResponse->FileSystem; | ||
| 113 | |||
| 114 | # Returns a L<Paws::FSX::CreateFileSystemFromBackupResponse> object. | ||
| 115 | |||
| 116 | 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. | ||
| 117 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fsx/CreateFileSystemFromBackup> | ||
| 118 | |||
| 119 | =head1 ATTRIBUTES | ||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> BackupId => Str | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 ClientRequestToken => Str | ||
| 129 | |||
| 130 | A string of up to 64 ASCII characters that Amazon FSx uses to ensure | ||
| 131 | idempotent creation. This string is automatically filled on your behalf | ||
| 132 | when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 KmsKeyId => Str | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 LustreConfiguration => L<Paws::FSX::CreateFileSystemLustreConfiguration> | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 149 | |||
| 150 | A list of IDs for the security groups that apply to the specified | ||
| 151 | network interfaces created for file system access. These security | ||
| 152 | groups apply to all network interfaces. This value isn't returned in | ||
| 153 | later DescribeFileSystem requests. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 StorageType => Str | ||
| 158 | |||
| 159 | Sets the storage type for the Windows file system you're creating from | ||
| 160 | a backup. Valid values are C<SSD> and C<HDD>. | ||
| 161 | |||
| 162 | =over | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | Set to C<SSD> to use solid state drive storage. Supported on all | ||
| 167 | Windows deployment types. | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | Set to C<HDD> to use hard disk drive storage. Supported on | ||
| 172 | C<SINGLE_AZ_2> and C<MULTI_AZ_1> Windows file system deployment types. | ||
| 173 | |||
| 174 | =back | ||
| 175 | |||
| 176 | Default value is C<SSD>. | ||
| 177 | |||
| 178 | HDD and SSD storage types have different minimum storage capacity | ||
| 179 | requirements. A restored file system's storage capacity is tied to the | ||
| 180 | file system that was backed up. You can create a file system that uses | ||
| 181 | HDD storage from a backup of a file system that used SSD storage only | ||
| 182 | if the original SSD file system had a storage capacity of at least 2000 | ||
| 183 | GiB. | ||
| 184 | |||
| 185 | Valid values are: C<"SSD">, C<"HDD"> | ||
| 186 | |||
| 187 | =head2 B<REQUIRED> SubnetIds => ArrayRef[Str|Undef] | ||
| 188 | |||
| 189 | Specifies the IDs of the subnets that the file system will be | ||
| 190 | accessible from. For Windows C<MULTI_AZ_1> file system deployment | ||
| 191 | types, provide exactly two subnet IDs, one for the preferred file | ||
| 192 | server and one for the standby file server. You specify one of these | ||
| 193 | subnets as the preferred subnet using the C<WindowsConfiguration E<gt> | ||
| 194 | PreferredSubnetID> property. | ||
| 195 | |||
| 196 | For Windows C<SINGLE_AZ_1> and C<SINGLE_AZ_2> deployment types and | ||
| 197 | Lustre file systems, provide exactly one subnet ID. The file server is | ||
| 198 | launched in that subnet's Availability Zone. | ||
| 199 | |||
| 200 | |||
| 201 | |||
| 202 | =head2 Tags => ArrayRef[L<Paws::FSX::Tag>] | ||
| 203 | |||
| 204 | The tags to be applied to the file system at file system creation. The | ||
| 205 | key value of the C<Name> tag appears in the console as the file system | ||
| 206 | name. | ||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head2 WindowsConfiguration => L<Paws::FSX::CreateFileSystemWindowsConfiguration> | ||
| 211 | |||
| 212 | The configuration for this Microsoft Windows file system. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head1 SEE ALSO | ||
| 218 | |||
| 219 | This class forms part of L<Paws>, documenting arguments for method CreateFileSystemFromBackup in L<Paws::FSX> | ||
| 220 | |||
| 221 | =head1 BUGS and CONTRIBUTIONS | ||
| 222 | |||
| 223 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 224 | |||
| 225 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 226 | |||
| 227 | =cut | ||
| 228 |