Class: Aws::AppStream::Types::CreateStackRequest

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

Overview

Note:

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

{
  name: "Name", # required
  description: "Description",
  display_name: "DisplayName",
  storage_connectors: [
    {
      connector_type: "HOMEFOLDERS", # required, accepts HOMEFOLDERS, GOOGLE_DRIVE, ONE_DRIVE
      resource_identifier: "ResourceIdentifier",
      domains: ["Domain"],
    },
  ],
  redirect_url: "RedirectURL",
  feedback_url: "FeedbackURL",
  user_settings: [
    {
      action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", # required, accepts CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE
      permission: "ENABLED", # required, accepts ENABLED, DISABLED
    },
  ],
  application_settings: {
    enabled: false, # required
    settings_group: "SettingsGroup",
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#application_settingsTypes::ApplicationSettings

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.



789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#descriptionString

The description to display.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#display_nameString

The stack name to display.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#feedback_urlString

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#nameString

The name of the stack.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#redirect_urlString

The URL that users are redirected to after their streaming session ends.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#storage_connectorsArray<Types::StorageConnector>

The storage connectors to enable.

Returns:



789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#tagsHash<String,String>

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

For more information about tags, see [Tagging Your Resources] in the *Amazon AppStream 2.0 Developer Guide*.

[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html

Returns:

  • (Hash<String,String>)


789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end

#user_settingsArray<Types::UserSetting>

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

Returns:



789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/aws-sdk-appstream/types.rb', line 789

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags)
  include Aws::Structure
end