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

Class: Aws::AppStream::Types::UpdateStackRequest

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 UpdateStackRequest data as a hash:

{
  display_name: "DisplayName",
  description: "Description",
  name: "String", # required
  storage_connectors: [
    {
      connector_type: "HOMEFOLDERS", # required, accepts HOMEFOLDERS, GOOGLE_DRIVE, ONE_DRIVE
      resource_identifier: "ResourceIdentifier",
      domains: ["Domain"],
    },
  ],
  delete_storage_connectors: false,
  redirect_url: "RedirectURL",
  feedback_url: "FeedbackURL",
  attributes_to_delete: ["STORAGE_CONNECTORS"], # accepts STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, EMBED_HOST_DOMAINS, IAM_ROLE_ARN, ACCESS_ENDPOINTS
  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",
  },
  access_endpoints: [
    {
      endpoint_type: "STREAMING", # required, accepts STREAMING
      vpce_id: "String",
    },
  ],
  embed_host_domains: ["EmbedHostDomain"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_endpointsArray<Types::AccessEndpoint>

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

Returns:



3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#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.



3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#attributes_to_deleteArray<String>

The stack attributes to delete.

Returns:

  • (Array<String>)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#delete_storage_connectorsBoolean

Deletes the storage connectors currently enabled for the stack.

Returns:

  • (Boolean)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#descriptionString

The description to display.

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#display_nameString

The stack name to display.

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#embed_host_domainsArray<String>

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

Returns:

  • (Array<String>)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#feedback_urlString

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

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#nameString

The name of the stack.

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#redirect_urlString

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

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end

#storage_connectorsArray<Types::StorageConnector>

The storage connectors to enable.

Returns:



3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  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:



3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3778

class UpdateStackRequest < Struct.new(
  :display_name,
  :description,
  :name,
  :storage_connectors,
  :delete_storage_connectors,
  :redirect_url,
  :feedback_url,
  :attributes_to_delete,
  :user_settings,
  :application_settings,
  :access_endpoints,
  :embed_host_domains)
  include Aws::Structure
end