Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appstream ]

update-stack¶

Description¶

Updates the specified fields for the specified stack.

Synopsis¶

  update-stack
[--display-name <value>]
[--description <value>]
--name <value>
[--storage-connectors <value>]
[--delete-storage-connectors | --no-delete-storage-connectors]
[--redirect-url <value>]
[--feedback-url <value>]
[--attributes-to-delete <value>]
[--user-settings <value>]
[--application-settings <value>]
[--access-endpoints <value>]
[--embed-host-domains <value>]
[--streaming-experience-settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--display-name (string)

The stack name to display.

--description (string)

The description to display.

--name (string)

The name of the stack.

--storage-connectors (list)

The storage connectors to enable.

(structure)

Describes a connector that enables persistent storage for users.

ConnectorType -> (string)

The type of storage connector.

ResourceIdentifier -> (string)

The ARN of the storage connector.

Domains -> (list)

The names of the domains for the account.

(string)

GSuite domain for GDrive integration.

Shorthand Syntax:

ConnectorType=string,ResourceIdentifier=string,Domains=string,string ...

JSON Syntax:

[
  {
    "ConnectorType": "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE",
    "ResourceIdentifier": "string",
    "Domains": ["string", ...]
  }
  ...
]

--delete-storage-connectors | --no-delete-storage-connectors (boolean)

Deletes the storage connectors currently enabled for the stack.

--redirect-url (string)

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

--feedback-url (string)

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.

--attributes-to-delete (list)

The stack attributes to delete.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  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

--user-settings (list)

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

(structure)

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Action -> (string)

The action that is enabled or disabled.

Permission -> (string)

Indicates whether the action is enabled or disabled.

MaximumLength -> (integer)

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED . This can't be specified when the permission is DISABLED .

This can only be specified for AlwaysOn and OnDemand fleets. The attribute is not supported on Elastic fleets.

The value can be between 1 and 20,971,520 (20 MB).

Shorthand Syntax:

Action=string,Permission=string,MaximumLength=integer ...

JSON Syntax:

[
  {
    "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": integer
  }
  ...
]

--application-settings (structure)

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.

Enabled -> (boolean)

Enables or disables persistent application settings for users during their streaming sessions.

SettingsGroup -> (string)

The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

Shorthand Syntax:

Enabled=boolean,SettingsGroup=string

JSON Syntax:

{
  "Enabled": true|false,
  "SettingsGroup": "string"
}

--access-endpoints (list)

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

(structure)

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

EndpointType -> (string)

The type of interface endpoint.

VpceId -> (string)

The identifier (ID) of the VPC in which the interface endpoint is used.

Shorthand Syntax:

EndpointType=string,VpceId=string ...

JSON Syntax:

[
  {
    "EndpointType": "STREAMING",
    "VpceId": "string"
  }
  ...
]

--embed-host-domains (list)

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.

(string)

Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]

Syntax:

"string" "string" ...

--streaming-experience-settings (structure)

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.

PreferredProtocol -> (string)

The preferred protocol that you want to use while streaming your application.

Shorthand Syntax:

PreferredProtocol=string

JSON Syntax:

{
  "PreferredProtocol": "TCP"|"UDP"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

Stack -> (structure)

Information about the stack.

Arn -> (string)

The ARN of the stack.

Name -> (string)

The name of the stack.

Description -> (string)

The description to display.

DisplayName -> (string)

The stack name to display.

CreatedTime -> (timestamp)

The time the stack was created.

StorageConnectors -> (list)

The storage connectors to enable.

(structure)

Describes a connector that enables persistent storage for users.

ConnectorType -> (string)

The type of storage connector.

ResourceIdentifier -> (string)

The ARN of the storage connector.

Domains -> (list)

The names of the domains for the account.

(string)

GSuite domain for GDrive integration.

RedirectURL -> (string)

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

FeedbackURL -> (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.

StackErrors -> (list)

The errors for the stack.

(structure)

Describes a stack error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

UserSettings -> (list)

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

(structure)

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Action -> (string)

The action that is enabled or disabled.

Permission -> (string)

Indicates whether the action is enabled or disabled.

MaximumLength -> (integer)

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED . This can't be specified when the permission is DISABLED .

This can only be specified for AlwaysOn and OnDemand fleets. The attribute is not supported on Elastic fleets.

The value can be between 1 and 20,971,520 (20 MB).

ApplicationSettings -> (structure)

The persistent application settings for users of the stack.

Enabled -> (boolean)

Specifies whether persistent application settings are enabled for users during their streaming sessions.

SettingsGroup -> (string)

The path prefix for the S3 bucket where users’ persistent application settings are stored.

S3BucketName -> (string)

The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

AccessEndpoints -> (list)

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

(structure)

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

EndpointType -> (string)

The type of interface endpoint.

VpceId -> (string)

The identifier (ID) of the VPC in which the interface endpoint is used.

EmbedHostDomains -> (list)

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.

(string)

Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]

StreamingExperienceSettings -> (structure)

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.

PreferredProtocol -> (string)

The preferred protocol that you want to use while streaming your application.

Table Of Contents

Feedback

User Guide

Note:

update-stack¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶