Skip to content

Update Stack

appstream_update_stack R Documentation

Updates the specified fields for the specified stack

Description

Updates the specified fields for the specified stack.

Usage

appstream_update_stack(DisplayName, Description, Name,
  StorageConnectors, DeleteStorageConnectors, RedirectURL, FeedbackURL,
  AttributesToDelete, UserSettings, ApplicationSettings, AccessEndpoints,
  EmbedHostDomains, StreamingExperienceSettings)

Arguments

DisplayName

The stack name to display.

Description

The description to display.

Name

[required] The name of the stack.

StorageConnectors

The storage connectors to enable.

DeleteStorageConnectors

Deletes the storage connectors currently enabled for the stack.

RedirectURL

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

FeedbackURL

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.

AttributesToDelete

The stack attributes to delete.

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.

AccessEndpoints

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

EmbedHostDomains

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.

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.

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

Request syntax

svc$update_stack(
  DisplayName = "string",
  Description = "string",
  Name = "string",
  StorageConnectors = list(
    list(
      ConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE",
      ResourceIdentifier = "string",
      Domains = list(
        "string"
      )
    )
  ),
  DeleteStorageConnectors = TRUE|FALSE,
  RedirectURL = "string",
  FeedbackURL = "string",
  AttributesToDelete = list(
    "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"|"STREAMING_EXPERIENCE_SETTINGS"
  ),
  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",
      Permission = "ENABLED"|"DISABLED",
      MaximumLength = 123
    )
  ),
  ApplicationSettings = list(
    Enabled = TRUE|FALSE,
    SettingsGroup = "string"
  ),
  AccessEndpoints = list(
    list(
      EndpointType = "STREAMING",
      VpceId = "string"
    )
  ),
  EmbedHostDomains = list(
    "string"
  ),
  StreamingExperienceSettings = list(
    PreferredProtocol = "TCP"|"UDP"
  )
)