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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::CreateStackRequest

Defined in:

gems/aws-sdk-appstream/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, DOMAIN_PASSWORD_SIGNIN, DOMAIN_SMART_CARD_SIGNIN
      permission: "ENABLED", # required, accepts ENABLED, DISABLED
    },
  ],
  application_settings: {
    enabled: false, # required
    settings_group: "SettingsGroup",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  access_endpoints: [
    {
      endpoint_type: "STREAMING", # required, accepts STREAMING
      vpce_id: "String",
    },
  ],
  embed_host_domains: ["EmbedHostDomain"],
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_endpoints ⇒ Array<Types::AccessEndpoint>

  The list of interface VPC endpoint (interface endpoint) objects.

• #application_settings ⇒ Types::ApplicationSettings

  The persistent application settings for users of a stack.

• #description ⇒ String

  The description to display.

• #display_name ⇒ String

  The stack name to display.

• #embed_host_domains ⇒ Array<String>

  The domains where AppStream 2.0 streaming sessions can be embedded in an iframe.

• #feedback_url ⇒ String

  The URL that users are redirected to after they click the Send Feedback link.

• #name ⇒ String

  The name of the stack.

• #redirect_url ⇒ String

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

• #storage_connectors ⇒ Array<Types::StorageConnector>

  The storage connectors to enable.

• #tags ⇒ Hash<String,String>

  The tags to associate with the stack.

• #user_settings ⇒ Array<Types::UserSetting>

  The actions that are enabled or disabled for users during their streaming sessions.

Instance Attribute Details

#access_endpoints ⇒ Array<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:

• (Array<Types::AccessEndpoint>)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#application_settings ⇒ Types::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.

Returns:

• (Types::ApplicationSettings)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description to display.

Returns:

• (String)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The stack name to display.

Returns:

• (String)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#embed_host_domains ⇒ Array<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>)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_url ⇒ String

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)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the stack.

Returns:

• (String)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_url ⇒ String

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

Returns:

• (String)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#storage_connectors ⇒ Array<Types::StorageConnector>

The storage connectors to enable.

Returns:

• (Array<Types::StorageConnector>)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<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.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Returns:

• (Hash<String,String>)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end

#user_settings ⇒ Array<Types::UserSetting>

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

Returns:

• (Array<Types::UserSetting>)

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

class CreateStackRequest < Struct.new(
  :name,
  :description,
  :display_name,
  :storage_connectors,
  :redirect_url,
  :feedback_url,
  :user_settings,
  :application_settings,
  :tags,
  :access_endpoints,
  :embed_host_domains)
  SENSITIVE = []
  include Aws::Structure
end