« blib/lib/Paws/AppStream/CreateDirectoryConfigResult.pm
↑ Summary
blib/lib/Paws/AppStream/CreateFleetResult.pm »
| 1 | |||
| 2 | package Paws::AppStream::CreateFleet; | ||
| 3 | use Moose; | ||
| 4 | has ComputeCapacity => (is => 'ro', isa => 'Paws::AppStream::ComputeCapacity', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has DisconnectTimeoutInSeconds => (is => 'ro', isa => 'Int'); | ||
| 7 | has DisplayName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DomainJoinInfo => (is => 'ro', isa => 'Paws::AppStream::DomainJoinInfo'); | ||
| 9 | has EnableDefaultInternetAccess => (is => 'ro', isa => 'Bool'); | ||
| 10 | has FleetType => (is => 'ro', isa => 'Str'); | ||
| 11 | has IamRoleArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has IdleDisconnectTimeoutInSeconds => (is => 'ro', isa => 'Int'); | ||
| 13 | has ImageArn => (is => 'ro', isa => 'Str'); | ||
| 14 | has ImageName => (is => 'ro', isa => 'Str'); | ||
| 15 | has InstanceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has MaxUserDurationInSeconds => (is => 'ro', isa => 'Int'); | ||
| 17 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 18 | has StreamView => (is => 'ro', isa => 'Str'); | ||
| 19 | has Tags => (is => 'ro', isa => 'Paws::AppStream::Tags'); | ||
| 20 | has VpcConfig => (is => 'ro', isa => 'Paws::AppStream::VpcConfig'); | ||
| 21 | |||
| 22 | use MooseX::ClassAttribute; | ||
| 23 | |||
| 24 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFleet'); | ||
| 25 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppStream::CreateFleetResult'); | ||
| 26 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 27 | 1; | ||
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::AppStream::CreateFleet - Arguments for method CreateFleet on L<Paws::AppStream> | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | This class represents the parameters used for calling the method CreateFleet on the | ||
| 38 | L<Amazon AppStream|Paws::AppStream> service. Use the attributes of this class | ||
| 39 | as arguments to method CreateFleet. | ||
| 40 | |||
| 41 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFleet. | ||
| 42 | |||
| 43 | =head1 SYNOPSIS | ||
| 44 | |||
| 45 | my $appstream2 = Paws->service('AppStream'); | ||
| 46 | my $CreateFleetResult = $appstream2->CreateFleet( | ||
| 47 | ComputeCapacity => { | ||
| 48 | DesiredInstances => 1, | ||
| 49 | |||
| 50 | }, | ||
| 51 | InstanceType => 'MyString', | ||
| 52 | Name => 'MyName', | ||
| 53 | Description => 'MyDescription', # OPTIONAL | ||
| 54 | DisconnectTimeoutInSeconds => 1, # OPTIONAL | ||
| 55 | DisplayName => 'MyDisplayName', # OPTIONAL | ||
| 56 | DomainJoinInfo => { | ||
| 57 | DirectoryName => 'MyDirectoryName', # OPTIONAL | ||
| 58 | OrganizationalUnitDistinguishedName => | ||
| 59 | 'MyOrganizationalUnitDistinguishedName', # max: 2000; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | EnableDefaultInternetAccess => 1, # OPTIONAL | ||
| 62 | FleetType => 'ALWAYS_ON', # OPTIONAL | ||
| 63 | IamRoleArn => 'MyArn', # OPTIONAL | ||
| 64 | IdleDisconnectTimeoutInSeconds => 1, # OPTIONAL | ||
| 65 | ImageArn => 'MyArn', # OPTIONAL | ||
| 66 | ImageName => 'MyString', # OPTIONAL | ||
| 67 | MaxUserDurationInSeconds => 1, # OPTIONAL | ||
| 68 | StreamView => 'APP', # OPTIONAL | ||
| 69 | Tags => { | ||
| 70 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 71 | }, # OPTIONAL | ||
| 72 | VpcConfig => { | ||
| 73 | SecurityGroupIds => [ | ||
| 74 | 'MyString', ... # min: 1 | ||
| 75 | ], # max: 5; OPTIONAL | ||
| 76 | SubnetIds => [ | ||
| 77 | 'MyString', ... # min: 1 | ||
| 78 | ], # OPTIONAL | ||
| 79 | }, # OPTIONAL | ||
| 80 | ); | ||
| 81 | |||
| 82 | # Results: | ||
| 83 | my $Fleet = $CreateFleetResult->Fleet; | ||
| 84 | |||
| 85 | # Returns a L<Paws::AppStream::CreateFleetResult> object. | ||
| 86 | |||
| 87 | 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. | ||
| 88 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appstream2/CreateFleet> | ||
| 89 | |||
| 90 | =head1 ATTRIBUTES | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> ComputeCapacity => L<Paws::AppStream::ComputeCapacity> | ||
| 94 | |||
| 95 | The desired capacity for the fleet. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 Description => Str | ||
| 100 | |||
| 101 | The description to display. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DisconnectTimeoutInSeconds => Int | ||
| 106 | |||
| 107 | The amount of time that a streaming session remains active after users | ||
| 108 | disconnect. If users try to reconnect to the streaming session after a | ||
| 109 | disconnection or network interruption within this time interval, they | ||
| 110 | are connected to their previous session. Otherwise, they are connected | ||
| 111 | to a new session with a new streaming instance. | ||
| 112 | |||
| 113 | Specify a value between 60 and 360000. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 DisplayName => Str | ||
| 118 | |||
| 119 | The fleet name to display. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 DomainJoinInfo => L<Paws::AppStream::DomainJoinInfo> | ||
| 124 | |||
| 125 | The name of the directory and organizational unit (OU) to use to join | ||
| 126 | the fleet to a Microsoft Active Directory domain. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 EnableDefaultInternetAccess => Bool | ||
| 131 | |||
| 132 | Enables or disables default internet access for the fleet. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 FleetType => Str | ||
| 137 | |||
| 138 | The fleet type. | ||
| 139 | |||
| 140 | =over | ||
| 141 | |||
| 142 | =item ALWAYS_ON | ||
| 143 | |||
| 144 | Provides users with instant-on access to their apps. You are charged | ||
| 145 | for all running instances in your fleet, even if no users are streaming | ||
| 146 | apps. | ||
| 147 | |||
| 148 | =item ON_DEMAND | ||
| 149 | |||
| 150 | Provide users with access to applications after they connect, which | ||
| 151 | takes one to two minutes. You are charged for instance streaming when | ||
| 152 | users are connected and a small hourly fee for instances that are not | ||
| 153 | streaming apps. | ||
| 154 | |||
| 155 | =back | ||
| 156 | |||
| 157 | |||
| 158 | Valid values are: C<"ALWAYS_ON">, C<"ON_DEMAND"> | ||
| 159 | |||
| 160 | =head2 IamRoleArn => Str | ||
| 161 | |||
| 162 | The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. | ||
| 163 | To assume a role, a fleet instance calls the AWS Security Token Service | ||
| 164 | (STS) C<AssumeRole> API operation and passes the ARN of the role to | ||
| 165 | use. The operation creates a new session with temporary credentials. | ||
| 166 | AppStream 2.0 retrieves the temporary credentials and creates the | ||
| 167 | B<appstream_machine_role> credential profile on the instance. | ||
| 168 | |||
| 169 | For more information, see Using an IAM Role to Grant Permissions to | ||
| 170 | Applications and Scripts Running on AppStream 2.0 Streaming Instances | ||
| 171 | (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) | ||
| 172 | in the I<Amazon AppStream 2.0 Administration Guide>. | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head2 IdleDisconnectTimeoutInSeconds => Int | ||
| 177 | |||
| 178 | The amount of time that users can be idle (inactive) before they are | ||
| 179 | disconnected from their streaming session and the | ||
| 180 | C<DisconnectTimeoutInSeconds> time interval begins. Users are notified | ||
| 181 | before they are disconnected due to inactivity. If they try to | ||
| 182 | reconnect to the streaming session before the time interval specified | ||
| 183 | in C<DisconnectTimeoutInSeconds> elapses, they are connected to their | ||
| 184 | previous session. Users are considered idle when they stop providing | ||
| 185 | keyboard or mouse input during their streaming session. File uploads | ||
| 186 | and downloads, audio in, audio out, and pixels changing do not qualify | ||
| 187 | as user activity. If users continue to be idle after the time interval | ||
| 188 | in C<IdleDisconnectTimeoutInSeconds> elapses, they are disconnected. | ||
| 189 | |||
| 190 | To prevent users from being disconnected due to inactivity, specify a | ||
| 191 | value of 0. Otherwise, specify a value between 60 and 3600. The default | ||
| 192 | value is 0. | ||
| 193 | |||
| 194 | If you enable this feature, we recommend that you specify a value that | ||
| 195 | corresponds exactly to a whole number of minutes (for example, 60, 120, | ||
| 196 | and 180). If you don't do this, the value is rounded to the nearest | ||
| 197 | minute. For example, if you specify a value of 70, users are | ||
| 198 | disconnected after 1 minute of inactivity. If you specify a value that | ||
| 199 | is at the midpoint between two different minutes, the value is rounded | ||
| 200 | up. For example, if you specify a value of 90, users are disconnected | ||
| 201 | after 2 minutes of inactivity. | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | =head2 ImageArn => Str | ||
| 206 | |||
| 207 | The ARN of the public, private, or shared image to use. | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head2 ImageName => Str | ||
| 212 | |||
| 213 | The name of the image used to create the fleet. | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head2 B<REQUIRED> InstanceType => Str | ||
| 218 | |||
| 219 | The instance type to use when launching fleet instances. The following | ||
| 220 | instance types are available: | ||
| 221 | |||
| 222 | =over | ||
| 223 | |||
| 224 | =item * | ||
| 225 | |||
| 226 | stream.standard.small | ||
| 227 | |||
| 228 | =item * | ||
| 229 | |||
| 230 | stream.standard.medium | ||
| 231 | |||
| 232 | =item * | ||
| 233 | |||
| 234 | stream.standard.large | ||
| 235 | |||
| 236 | =item * | ||
| 237 | |||
| 238 | stream.compute.large | ||
| 239 | |||
| 240 | =item * | ||
| 241 | |||
| 242 | stream.compute.xlarge | ||
| 243 | |||
| 244 | =item * | ||
| 245 | |||
| 246 | stream.compute.2xlarge | ||
| 247 | |||
| 248 | =item * | ||
| 249 | |||
| 250 | stream.compute.4xlarge | ||
| 251 | |||
| 252 | =item * | ||
| 253 | |||
| 254 | stream.compute.8xlarge | ||
| 255 | |||
| 256 | =item * | ||
| 257 | |||
| 258 | stream.memory.large | ||
| 259 | |||
| 260 | =item * | ||
| 261 | |||
| 262 | stream.memory.xlarge | ||
| 263 | |||
| 264 | =item * | ||
| 265 | |||
| 266 | stream.memory.2xlarge | ||
| 267 | |||
| 268 | =item * | ||
| 269 | |||
| 270 | stream.memory.4xlarge | ||
| 271 | |||
| 272 | =item * | ||
| 273 | |||
| 274 | stream.memory.8xlarge | ||
| 275 | |||
| 276 | =item * | ||
| 277 | |||
| 278 | stream.memory.z1d.large | ||
| 279 | |||
| 280 | =item * | ||
| 281 | |||
| 282 | stream.memory.z1d.xlarge | ||
| 283 | |||
| 284 | =item * | ||
| 285 | |||
| 286 | stream.memory.z1d.2xlarge | ||
| 287 | |||
| 288 | =item * | ||
| 289 | |||
| 290 | stream.memory.z1d.3xlarge | ||
| 291 | |||
| 292 | =item * | ||
| 293 | |||
| 294 | stream.memory.z1d.6xlarge | ||
| 295 | |||
| 296 | =item * | ||
| 297 | |||
| 298 | stream.memory.z1d.12xlarge | ||
| 299 | |||
| 300 | =item * | ||
| 301 | |||
| 302 | stream.graphics-design.large | ||
| 303 | |||
| 304 | =item * | ||
| 305 | |||
| 306 | stream.graphics-design.xlarge | ||
| 307 | |||
| 308 | =item * | ||
| 309 | |||
| 310 | stream.graphics-design.2xlarge | ||
| 311 | |||
| 312 | =item * | ||
| 313 | |||
| 314 | stream.graphics-design.4xlarge | ||
| 315 | |||
| 316 | =item * | ||
| 317 | |||
| 318 | stream.graphics-desktop.2xlarge | ||
| 319 | |||
| 320 | =item * | ||
| 321 | |||
| 322 | stream.graphics.g4dn.xlarge | ||
| 323 | |||
| 324 | =item * | ||
| 325 | |||
| 326 | stream.graphics.g4dn.2xlarge | ||
| 327 | |||
| 328 | =item * | ||
| 329 | |||
| 330 | stream.graphics.g4dn.4xlarge | ||
| 331 | |||
| 332 | =item * | ||
| 333 | |||
| 334 | stream.graphics.g4dn.8xlarge | ||
| 335 | |||
| 336 | =item * | ||
| 337 | |||
| 338 | stream.graphics.g4dn.12xlarge | ||
| 339 | |||
| 340 | =item * | ||
| 341 | |||
| 342 | stream.graphics.g4dn.16xlarge | ||
| 343 | |||
| 344 | =item * | ||
| 345 | |||
| 346 | stream.graphics-pro.4xlarge | ||
| 347 | |||
| 348 | =item * | ||
| 349 | |||
| 350 | stream.graphics-pro.8xlarge | ||
| 351 | |||
| 352 | =item * | ||
| 353 | |||
| 354 | stream.graphics-pro.16xlarge | ||
| 355 | |||
| 356 | =back | ||
| 357 | |||
| 358 | |||
| 359 | |||
| 360 | |||
| 361 | =head2 MaxUserDurationInSeconds => Int | ||
| 362 | |||
| 363 | The maximum amount of time that a streaming session can remain active, | ||
| 364 | in seconds. If users are still connected to a streaming instance five | ||
| 365 | minutes before this limit is reached, they are prompted to save any | ||
| 366 | open documents before being disconnected. After this time elapses, the | ||
| 367 | instance is terminated and replaced by a new instance. | ||
| 368 | |||
| 369 | Specify a value between 600 and 360000. | ||
| 370 | |||
| 371 | |||
| 372 | |||
| 373 | =head2 B<REQUIRED> Name => Str | ||
| 374 | |||
| 375 | A unique name for the fleet. | ||
| 376 | |||
| 377 | |||
| 378 | |||
| 379 | =head2 StreamView => Str | ||
| 380 | |||
| 381 | The AppStream 2.0 view that is displayed to your users when they stream | ||
| 382 | from the fleet. When C<APP> is specified, only the windows of | ||
| 383 | applications opened by users display. When C<DESKTOP> is specified, the | ||
| 384 | standard desktop that is provided by the operating system displays. | ||
| 385 | |||
| 386 | The default value is C<APP>. | ||
| 387 | |||
| 388 | Valid values are: C<"APP">, C<"DESKTOP"> | ||
| 389 | |||
| 390 | =head2 Tags => L<Paws::AppStream::Tags> | ||
| 391 | |||
| 392 | The tags to associate with the fleet. A tag is a key-value pair, and | ||
| 393 | the value is optional. For example, Environment=Test. If you do not | ||
| 394 | specify a value, Environment=. | ||
| 395 | |||
| 396 | If you do not specify a value, the value is set to an empty string. | ||
| 397 | |||
| 398 | Generally allowed characters are: letters, numbers, and spaces | ||
| 399 | representable in UTF-8, and the following special characters: | ||
| 400 | |||
| 401 | _ . : / = + \ - @ | ||
| 402 | |||
| 403 | For more information, see Tagging Your Resources | ||
| 404 | (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) | ||
| 405 | in the I<Amazon AppStream 2.0 Administration Guide>. | ||
| 406 | |||
| 407 | |||
| 408 | |||
| 409 | =head2 VpcConfig => L<Paws::AppStream::VpcConfig> | ||
| 410 | |||
| 411 | The VPC configuration for the fleet. | ||
| 412 | |||
| 413 | |||
| 414 | |||
| 415 | |||
| 416 | =head1 SEE ALSO | ||
| 417 | |||
| 418 | This class forms part of L<Paws>, documenting arguments for method CreateFleet in L<Paws::AppStream> | ||
| 419 | |||
| 420 | =head1 BUGS and CONTRIBUTIONS | ||
| 421 | |||
| 422 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 423 | |||
| 424 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 425 | |||
| 426 | =cut | ||
| 427 |