You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppStream::Types::CreateStreamingURLRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Note:

When making an API call, you may pass CreateStreamingURLRequest data as a hash:

{
  stack_name: "String", # required
  fleet_name: "String", # required
  user_id: "StreamingUrlUserId", # required
  application_id: "String",
  validity: 1,
  session_context: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 566

class CreateStreamingURLRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :application_id,
  :validity,
  :session_context)
  include Aws::Structure
end

#fleet_nameString

The name of the fleet.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 566

class CreateStreamingURLRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :application_id,
  :validity,
  :session_context)
  include Aws::Structure
end

#session_contextString

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Developer Guide.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 566

class CreateStreamingURLRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :application_id,
  :validity,
  :session_context)
  include Aws::Structure
end

#stack_nameString

The name of the stack.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 566

class CreateStreamingURLRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :application_id,
  :validity,
  :session_context)
  include Aws::Structure
end

#user_idString

The ID of the user.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 566

class CreateStreamingURLRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :application_id,
  :validity,
  :session_context)
  include Aws::Structure
end

#validityInteger

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

Returns:

  • (Integer)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 566

class CreateStreamingURLRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :application_id,
  :validity,
  :session_context)
  include Aws::Structure
end