Skip to content

Creates a stack to start streaming applications to users

Description

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Usage

appstream_create_stack(Name, Description, DisplayName,
  StorageConnectors, RedirectURL, FeedbackURL, UserSettings,
  ApplicationSettings, Tags, AccessEndpoints, EmbedHostDomains,
  StreamingExperienceSettings, ContentRedirection, AgentAccessConfig)

Arguments

  • Name

    [required] The name of the stack.

  • Description

    The description to display.

  • DisplayName

    The stack name to display.

  • StorageConnectors

    The storage connectors to enable.

  • RedirectURL

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

  • FeedbackURL

    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.

  • UserSettings

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

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

  • Tags

    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 WorkSpaces Applications Administration Guide.

  • AccessEndpoints

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

  • EmbedHostDomains

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

  • StreamingExperienceSettings

    The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

  • ContentRedirection

    Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.

  • AgentAccessConfig

    The configuration for agent access on the stack. If specified, agent access is enabled for the stack.

Value

A list with the following syntax:

list(
  Stack = list(
    Arn = "string",
    Name = "string",
    Description = "string",
    DisplayName = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    StorageConnectors = list(
      list(
        ConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE",
        ResourceIdentifier = "string",
        Domains = list(
          "string"
        ),
        DomainsRequireAdminConsent = list(
          "string"
        )
      )
    ),
    RedirectURL = "string",
    FeedbackURL = "string",
    StackErrors = list(
      list(
        ErrorCode = "STORAGE_CONNECTOR_ERROR"|"INTERNAL_SERVICE_ERROR",
        ErrorMessage = "string"
      )
    ),
    UserSettings = list(
      list(
        Action = "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"|"AUTO_TIME_ZONE_REDIRECTION",
        Permission = "ENABLED"|"DISABLED",
        MaximumLength = 123
      )
    ),
    ApplicationSettings = list(
      Enabled = TRUE|FALSE,
      SettingsGroup = "string",
      S3BucketName = "string"
    ),
    AccessEndpoints = list(
      list(
        EndpointType = "STREAMING",
        VpceId = "string"
      )
    ),
    EmbedHostDomains = list(
      "string"
    ),
    StreamingExperienceSettings = list(
      PreferredProtocol = "TCP"|"UDP"
    ),
    ContentRedirection = list(
      HostToClient = list(
        Enabled = TRUE|FALSE,
        AllowedUrls = list(
          "string"
        ),
        DeniedUrls = list(
          "string"
        )
      )
    ),
    AgentAccessConfig = list(
      Settings = list(
        list(
          AgentAction = "COMPUTER_VISION"|"COMPUTER_INPUT"|"FORWARD_MCP_TOOLS",
          Permission = "ENABLED"|"DISABLED"
        )
      ),
      S3BucketArn = "string",
      ScreenshotsUploadEnabled = TRUE|FALSE,
      ScreenResolution = "W_1280xH_720",
      ScreenImageFormat = "PNG"|"JPEG",
      UserControlMode = "VIEW_ONLY"|"VIEW_STOP"|"DISABLED"
    )
  )
)

Request syntax

svc$create_stack(
  Name = "string",
  Description = "string",
  DisplayName = "string",
  StorageConnectors = list(
    list(
      ConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE",
      ResourceIdentifier = "string",
      Domains = list(
        "string"
      ),
      DomainsRequireAdminConsent = list(
        "string"
      )
    )
  ),
  RedirectURL = "string",
  FeedbackURL = "string",
  UserSettings = list(
    list(
      Action = "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"|"AUTO_TIME_ZONE_REDIRECTION",
      Permission = "ENABLED"|"DISABLED",
      MaximumLength = 123
    )
  ),
  ApplicationSettings = list(
    Enabled = TRUE|FALSE,
    SettingsGroup = "string"
  ),
  Tags = list(
    "string"
  ),
  AccessEndpoints = list(
    list(
      EndpointType = "STREAMING",
      VpceId = "string"
    )
  ),
  EmbedHostDomains = list(
    "string"
  ),
  StreamingExperienceSettings = list(
    PreferredProtocol = "TCP"|"UDP"
  ),
  ContentRedirection = list(
    HostToClient = list(
      Enabled = TRUE|FALSE,
      AllowedUrls = list(
        "string"
      ),
      DeniedUrls = list(
        "string"
      )
    )
  ),
  AgentAccessConfig = list(
    Settings = list(
      list(
        AgentAction = "COMPUTER_VISION"|"COMPUTER_INPUT"|"FORWARD_MCP_TOOLS",
        Permission = "ENABLED"|"DISABLED"
      )
    ),
    S3BucketArn = "string",
    ScreenshotsUploadEnabled = TRUE|FALSE,
    ScreenResolution = "W_1280xH_720",
    ScreenImageFormat = "PNG"|"JPEG",
    UserControlMode = "VIEW_ONLY"|"VIEW_STOP"|"DISABLED"
  )
)