update-stack¶
Description¶
Updates the specified fields for the specified stack.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
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>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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
--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.
Shorthand Syntax:
Action=string,Permission=string ...
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"
}
...
]
--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" ...
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
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.
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”. “”]