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