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
• Struct
• Aws::AppStream::Types::CreateStreamingURLRequest

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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

  The name of the application to launch after the session starts.

• #fleet_name ⇒ String

  The name of the fleet.

• #session_context ⇒ String

  The session context.

• #stack_name ⇒ String

  The name of the stack.

• #user_id ⇒ String

  The identifier of the user.

• #validity ⇒ Integer

  The time that the streaming URL will be valid, in seconds.

Instance Attribute Details

#application_id ⇒ String

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)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1075

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

#fleet_name ⇒ String

The name of the fleet.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1075

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

#session_context ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1075

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

#stack_name ⇒ String

The name of the stack.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1075

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

#user_id ⇒ String

The identifier of the user.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1075

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

#validity ⇒ Integer

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)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1075

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