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 ID of the application that must be launched after the session starts.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 404

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

#fleet_nameString

The fleet for which the URL is generated.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 404

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

#session_contextString

The sessionContext of the streaming URL.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 404

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

#stack_nameString

The stack for which the URL is generated.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 404

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

#user_idString

A unique user ID for whom the URL is generated.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 404

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

#validityInteger

The duration up to which the URL returned by this action is valid. The input can be any numeric value in seconds between 1 and 604800 seconds.

Returns:

  • (Integer)


404
405
406
407
408
409
410
411
412
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 404

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